botframework-config

v4.23.1-deprecated

library for working with Bot Framework .bot configuration files For more information about how to use this package see README

Latest version published 3 months ago

License: MIT

NPM

GitHub

Package Health Score

60 / 100

security
No known security issues
popularity
Limited
maintenance
Inactive
community
Active

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
4.23.1-deprecated	\|	09/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.9.5	\|	06/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.10.6	\|	06/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.11.2	\|	06/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.8.1	\|	12/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Yes

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (460)

GitHub Stars: 689
Forks: 281
Contributors: 140

Direct Usage Popularity

The npm package botframework-config receives a total of 460 downloads a week. As such, we scored botframework-config popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package botframework-config, we found that it has been starred 689 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: No
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 140
Funding: No

A good and healthy external contribution signal for botframework-config project, which invites more than one hundred open source maintainers to collaborate on the repository.

How about a good first contribution to this project? It seems that botframework-config is missing a README file.

Embed Package Health Score Badge

Maintenance

Inactive

deprecated

Commit Frequency

Open Issues: 26
Open PR: 16
Last Release: 3 months ago
Last Commit: 13 days ago

Further analysis of the maintenance status of botframework-config based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

We found that botframework-config demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=8.0

Age: 6 years
Dependencies: 2 Direct
Versions: 538
Install Size: 167 kB
Dist-tags: 4
# of Files: 110
Maintainers: 3
TS Typings: Yes

botframework-config has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use botframework-config?

To help you get started, we've collected the most common ways that botframework-config is being used within popular public projects.

microsoft / BotBuilder-Samples / samples / javascript_nodejs / 15.handling-attachments / index.js View on Github

const { BotFrameworkAdapter } = require('botbuilder');
const { BotConfiguration } = require('botframework-config');
const { AttachmentsBot } = require('./bot');

// Read botFilePath and botFileSecret from .env file.
// Note: Ensure you have a .env file and include botFilePath and botFileSecret.
const ENV_FILE = path.join(__dirname, './.env');
require('dotenv').config({ path: ENV_FILE });

// Get the .bot file path.
// See https://aka.ms/about-bot-file to learn more about .bot files.
const BOT_FILE = path.join(__dirname, (process.env.botFilePath || ''));
let botConfig;
try {
    // Read bot configuration from .bot file.
    botConfig = BotConfiguration.loadSync(BOT_FILE, process.env.botFileSecret);
} catch (err) {
    console.error(`\nError reading bot file. Please ensure you have valid botFilePath and botFileSecret set for your environment.`);
    console.error(`\n - The botFileSecret is available under appsettings for your Azure Bot Service bot.`);
    console.error(`\n - If you are running this bot locally, consider adding a .env file with botFilePath and botFileSecret.`);
    console.error(`\n - See https://aka.ms/about-bot-file to learn more about .bot file its use and bot configuration.\n\n`);
    process.exit();
}

// For local development configuration as defined in .bot file.
const DEV_ENVIRONMENT = 'development';

// Bot name as defined in .bot file or from runtime.
const BOT_CONFIGURATION = (process.env.NODE_ENV || DEV_ENVIRONMENT);

// Get bot endpoint configuration by service name.
const endpointConfig = botConfig.findServiceByNameOrId(BOT_CONFIGURATION);

View more ways to use botframework-config

botframework-config dependencies

uuid fs-extra

botframework-config development dependencies

@types/uuid

FAQs

What is botframework-config?

library for working with Bot Framework .bot configuration files. Visit Snyk Advisor to see a full health score report for botframework-config, including popularity, security, maintenance & community analysis.

Is botframework-config popular?

The npm package botframework-config receives a total of 460 weekly downloads. As such, botframework-config popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is botframework-config well maintained?

We found indications that botframework-config is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is botframework-config safe to use?

The npm package botframework-config was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 20 December-2024, at 05:10 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP