Product
Introducing Socket Optimize
We're excited to introduce Socket Dependency Optimization, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.
@anolilab/lint-staged-config
Advanced tools
Package that contains shareable configuration for lint-staged — a popular tool for running linters on staged Git files.
And optionally for husky — a popular choice for configuring git hooks.
Daniel Bannert's open source work is supported by the community on GitHub Sponsors
Simplify your project setup with our comprehensive collection of preconfigured configuration files. Designed for effortless integration, these ready-to-use files can be seamlessly imported into your projects. These functions streamline the utilization of lint-staged alongside popular tools such as ESLint, Prettier, StyleLint and SecretLint.
Say goodbye to complex configurations and enjoy a smoother development experience with our all-inclusive package.
npm install --dev-save @anolilab/lint-staged-config lint-staged
Optional:
npm install --dev-save husky is-ci
yarn add -D @anolilab/lint-staged-config lint-staged
Optional:
yarn add -D husky is-ci
pnpm add -D @anolilab/lint-staged-config lint-staged
Optional:
pnpm add -D husky is-ci
If you don’t have a .lintstagedrc.js
, we will create the file for you after installing @anolilab/lint-staged-config
.
If you already have a .lintstagedrc.js
, then you can extend the .lintstagedrc.js
, with @anolilab/lint-staged-config
.
Note: If the script detects an existing
.lintstagedrc.js
file, it will not overwrite it.
Note: It can happen that the postinstall script don't run, then you have to add the
.lintstagedrc.js
manually.
The content of the .lintstagedrc.js
should look like this:
const config = require("@anolilab/lint-staged-config");
module.exports = {
...config,
};
You can configure @anolilab/lint-staged-config
options with your package.json
file.
Add this property to your package.json:
{
anolilab: {
"lint-staged-config": {
// ...options
},
},
}
Type: object
Options:
exclude
- Exclude files from tsc linting. Provide the path to the tsconfig.json file.
string[]
[]
Example using package.json:
{
"anolilab": {
"lint-staged-config": {
"typescript": {
// ...options
}
}
}
}
Type: object
Options:
cache
- Enable or disable caching.
boolean
string
string[]
number | string | false
string[]
Example using package.json:
{
"anolilab": {
"lint-staged-config": {
"eslint": {
// ...options
}
}
}
}
The default configuration, automatically adds the following linting and formatting tools, if the needed dependencies are installed.
All this tools configuration are exported at @anolilab/lint-staged-config/group/...
and
can be used to extend your configuration, without including the auto config.
If you want to use husky to run the lint-staged script, you can use the following configuration.
Adding the following script to your root package.json
file makes it easier to run the husky command:
pnpm pkg set scripts.prepare="is-ci || husky install || exit 0"
For npm
users, replace pnpm
with npm
in the above command.
This script will install husky only if it is not running in a CI environment.
After that you can find a .husky
folder in your root directory, with a pre-commit
(if not please create it) file.
The file content can look like this:
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"
# The hook should exit with non-zero status after issuing
# an appropriate message if it wants to stop the commit.
echo --------------------------------------------
echo Starting Git hook: pre-commit
pnpx lint-staged --verbose --concurrent false
echo Finished Git hook: pre-commit
echo --------------------------------------------
Our package includes a postinstall
script to automatically add the pre-commit
, common.sh
, prepare-commit-msg hooks to your
.husky` folder.
Note: It can be that the postinstall script don't run, then you have to add the hooks manually.
If commitzen
is installed, the prepare-commit-msg
hook with predefined content will be added to your .husky
folder.
Libraries in this ecosystem make the best effort to track Node.js’ release schedule. Here’s a post on why we think this is important.
If you would like to help take a look at the list of issues and check our Contributing guild.
Note: please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
The anolilab javascript-style-guide is open-sourced software licensed under the MIT license
FAQs
Shareable Lint-Staged Config for any project.
We found that @anolilab/lint-staged-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.
Product
We're excited to introduce Socket Dependency Optimization, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.
Product
We're excited to announce that Socket now supports the Java programming language.
Security News
Socket detected a malicious Python package impersonating a popular browser cookie library to steal passwords, screenshots, webcam images, and Discord tokens.