Security News
Introducing the Socket Python SDK
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
@nhcarrigan/eslint-config
Advanced tools
This package holds my ESLint configuration for easy installation and syncing changes across projects.
This package is currently published. View the npm
page.
To install this package, run the following command:
npm i @nhcarrigan/eslint-config eslint
This package is compatible with ESLint 9.
To use this package, add the following to your eslint.config.js
file:
import NaomisConfig from "@nhcarrigan/eslint-config";
export default [
...NaomisConfig,
// Any overrides you need, such as:
// {
// rules: {
// complexity: "off",
// "max-lines-per-function": "off",
// "max-statements": "off",
// "jsdoc/require-file-overview": "off"
// },
// },
// {
// files: ["test/__mocks__/Database.mock.ts"],
// rules: {
// "require-await": "off"
// }
// },
];
Then set up these two scripts in your package.json
:
{
"format": "eslint src test --max-warnings 0 --fix",
"lint": "eslint src test --max-warnings 0",
}
Our rulesets include the stylistic
package, which enforces quite a bit of specific formatting. With this being the case, projects should NOT use Prettier in tandem with this config.
Instead, set your editor to run the ESLint formatter on save. For example, in VSCodium, you can add a .vscode/settings.json
file to your project:
{
"editor.codeActionsOnSave": {
"source.fixAll.eslint": "explicit"
},
"eslint.validate": ["typescript"]
}
This configuration does not extend or incorporate any external rulesets. Every rule this config sets has been added deliberately and with reason.
A rule is set to be a warning when it is something that is okay during development (e.g. using a console.log
, or not having a JSDoc definition yet) but should not make it to production code.
A rule is set to an error when it is something that should not occur in development or production (e.g. missing semi-colons, using loose equality).
Because this config is built from scratch, there is no need to explicitly deactivate any rules. Everything is "off" by default, and turned on as desired by this package.
The tests will not allow you to explicitly disable rules.
The only exception is the disabledEslintRules
object, which explicitly turns off built-in ESLint rules to avoid conflicts with external packages like @typescript-eslint
.
All style changes should be proposed in our chat server.
If you have feedback or a bug report, please feel free to open a GitHub issue!
If you would like to contribute to the project, you may create a Pull Request containing your proposed changes and we will review it as soon as we are able! Please review our contributing guidelines first.
Before interacting with our community, please read our Code of Conduct.
This software is licensed under our global software license.
Copyright held by Naomi Carrigan.
We may be contacted through our Chat Server or via email at contact@nhcarrigan.com
.
FAQs
Global config for ESLint
The npm package @nhcarrigan/eslint-config receives a total of 24 weekly downloads. As such, @nhcarrigan/eslint-config popularity was classified as not popular.
We found that @nhcarrigan/eslint-config demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.
Security News
A new Rust RFC proposes "Trusted Publishing" for Crates.io, introducing short-lived access tokens via OIDC to improve security and reduce risks associated with long-lived API tokens.