@fluidframework/eslint-config-fluid

v5.6.0

Shareable ESLint config for the Fluid Framework For more information about how to use this package see README

Latest version published 30 days ago

License: MIT

NPM

GitHub

Package Health Score

86 / 100

security
No known security issues
popularity
Recognized
maintenance
Healthy
community
Active

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
5.6.0	\|	11/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
5.5.1	\|	11/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
5.3.0	\|	04/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.0.0	\|	02/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.5.0	\|	02/2024		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

Recognized

Weekly Downloads (1,209)

GitHub Stars: 4.74K
Forks: 533
Contributors: 240

Direct Usage Popularity

The npm package @fluidframework/eslint-config-fluid receives a total of 1,209 downloads a week. As such, we scored @fluidframework/eslint-config-fluid popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package @fluidframework/eslint-config-fluid, we found that it has been starred 4,740 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: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 240
Funding: No

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

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 15
Open PR: 113
Last Release: 30 days ago
Last Commit: 1 month ago

Further analysis of the maintenance status of @fluidframework/eslint-config-fluid based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that @fluidframework/eslint-config-fluid 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: not defined

Age: 4 years
Dependencies: 19 Direct
Versions: 62
Install Size: 356 kB
Dist-tags: 3
# of Files: 27
Maintainers: 1
TS Typings: No

@fluidframework/eslint-config-fluid 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.

Readme

@fluidframework/eslint-config-fluid

This package contains a shared ESLint config used by all the packages in the Fluid Framework repo.

It exports the following shared ESLint configs:

Configurations

Strict

The strictest config for use in Fluid Framework libraries. Recommended for highest code quality enforcement.

In particular, use of this config is encouraged for libraries with public facing APIs, and those used as external-facing examples (e.g. those mentioned on fluidframework.com).

Imported via @fluidframework/eslint-config-fluid/strict.

Strict-Biome

A version of the "strict" config that disables rules that are supported by Biome's "recommended" lint config. This config is intended to be used in projects that use both eslint and Biome for linting. This config is considered experimental.

Changing the lint config

If you want to change the shared lint config (that is, this package), you need to do the following:

Make the change in the config.
Publish a pre-release package.
Update the core packages to use the pre-release lint config.

When updating the lint config (step 1), run npm run build and commit any resulting changes.

Tracking lint config changes over time

One question that comes up often when we make changes to our lint config is, "what changed?" This applies even when we don't make any changes other than upgrading deps, because the dependency upgrade might include a new rule.

ESLint provides a way to print the config that would apply to a file (--print-config), so we use this capability to print out the applied config as a JSON file. As we make changes to the config, we can print out the config again and get a diff to review as part of a PR -- just like we do with API reports for code changes.

Scripts

Script	Description
`build`	`npm run print-config`
`build:readme`	`markdown-magic --files "*/.md"`
`cleanup-printed-configs`	Clean up the printed configs. Removes the `parser` property and sorts the JSON.
`format`	`npm run prettier:fix`
`prettier`	`prettier --check .`
`prettier:fix`	`prettier --write .`
`print-config`	Print all the eslint configs.
`print-config:default`	Print the eslint config for regular TypeScript files (`eslint --config index.js --print-config src/file.ts`).
`print-config:minimal`	`eslint --config ./minimal-deprecated.js --print-config ./src/file.ts > ./printed-configs/minimal.json`
`print-config:react`	`eslint --config ./index.js --print-config ./src/file.tsx > ./printed-configs/react.json`
`print-config:recommended`	`eslint --config ./recommended.js --print-config ./src/file.ts > ./printed-configs/recommended.json`
`print-config:strict`	`eslint --config ./strict.js --print-config ./src/file.ts > ./printed-configs/strict.json`
`print-config:strict-biome`	`eslint --config ./strict-biome.js --print-config ./src/file.ts > ./printed-configs/strict-biome.json`
`print-config:test`	Print the eslint config for test files (`eslint --config index.js --print-config src/test/file.ts`).
`test`	`echo TODO: add tests in @fluidframework/eslint-config-fluid`

See GitHub for more details on the Fluid Framework and packages within.

@fluidframework/eslint-config-fluid dependencies

@fluid-internal/eslint-plugin-fluid @microsoft/tsdoc @rushstack/eslint-patch @rushstack/eslint-plugin @rushstack/eslint-plugin-security @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-config-biome eslint-config-prettier eslint-import-resolver-typescript eslint-plugin-eslint-comments eslint-plugin-import eslint-plugin-jsdoc eslint-plugin-promise eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-tsdoc eslint-plugin-unicorn eslint-plugin-unused-imports

@fluidframework/eslint-config-fluid development dependencies

@fluid-tools/markdown-magic @fluidframework/build-common concurrently eslint mocha-multi-reporters prettier sort-json typescript

FAQs

What is @fluidframework/eslint-config-fluid?

Shareable ESLint config for the Fluid Framework. Visit Snyk Advisor to see a full health score report for @fluidframework/eslint-config-fluid, including popularity, security, maintenance & community analysis.

Is @fluidframework/eslint-config-fluid popular?

The npm package @fluidframework/eslint-config-fluid receives a total of 1,209 weekly downloads. As such, @fluidframework/eslint-config-fluid popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @fluidframework/eslint-config-fluid well maintained?

We found that @fluidframework/eslint-config-fluid demonstrated a healthy version release cadence and project activity. It has a community of 240 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @fluidframework/eslint-config-fluid safe to use?

The npm package @fluidframework/eslint-config-fluid 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 10 December-2024, at 12:57 (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

Package Health Score

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (1,209)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

@fluidframework/eslint-config-fluid

Configurations

Recommended

Strict

Strict-Biome

Changing the lint config

Tracking lint config changes over time

Scripts

@fluidframework/eslint-config-fluid dependencies

@fluidframework/eslint-config-fluid development dependencies

FAQs

What is @fluidframework/eslint-config-fluid?

Is @fluidframework/eslint-config-fluid popular?

Is @fluidframework/eslint-config-fluid well maintained?

Is @fluidframework/eslint-config-fluid safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues