npmpackage.info

eslint-config-nstarter

Basic eslint rules for nstarter projects.

4.0.1

JavaScript

151.00 B

Installations

npm install eslint-config-nstarter

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

20.16.0

NPM Version

10.8.1 Score

Supply Chain

88.4

Quality

75.7

Maintenance

100

Vulnerability

96.1

License

Pull Requests

Open

0

Total

20

Closed

20

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View All 15 Contributors

Languages

JavaScript

TypeScript

CSS

Groovy

HTML

Dockerfile

Makefile

Shell

JavaScript (75.41%)

TypeScript (22.44%)

CSS (1.07%)

Groovy (0.45%)

HTML (0.25%)

Dockerfile (0.21%)

Makefile (0.1%)

Shell (0.06%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

jiandaoyun

Download Statistics

Total Downloads

5,294

Last Day

Last Week

Last Month

Last Year

1,020

GitHub Statistics

1 Stars

514 Commits

2 Watchers

4 Branches

15 Contributors

Updated on Sep 04, 2024

Bundle Size

175.00 B

Minified

151.00 B

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

4.0.1

Package Id

eslint-config-nstarter@4.0.1

Unpacked Size

60.76 kB

Size

16.84 kB

File Count

NPM Version

10.8.1

Node Version

20.16.0

Published on

Aug 02, 2024

Total Downloads

Cumulative downloads

Total Downloads

5,294

Last Day

-50%

Compared to previous day

Last Week

-59.1%

Compared to previous week

Last Month

50.9%

Compared to previous month

Last Year

-10.6%

1,020

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

NStarter ESLint 规则

NStarter ESLint 规则在腾讯 Alloy ESLint 规则基础上定制而来，用于规范化 nstarter 系列项目的代码编写规范。

规则列表

名称	包含规则	解析器
标准规则	ESLint 规则	@babel/eslint-parser
TypeScript	ESLint 规则、@typescript-eslint	@typescript-eslint/parser

设计理念

传承 ESLint 的理念，帮助大家建立自己的规则
高度的自动化：先进的规则管理，测试即文档即[网站][]

传承 [ESLint 的理念][]，帮助大家建立自己的规则

大家还记得 ESLint 是怎么打败 JSHint 成为最受欢迎的 js 代码检查工具吗？就是因为 ESLint 推崇的插件化、配置化，满足了不同团队不同技术栈的个性的需求。

所以 eslint-config-nstarter 也传承了 ESLint 的设计理念，不会强调必须要使用我们这套规则，而是通过文档、示例、测试、网站等方便大家参考 nstarter 的规则，在此基础上做出自己的个性化。

高度的自动化：先进的规则管理，测试即文档即[网站][]

无情的推动自动化

eslint-config-nstarter 通过高度的自动化，将一切能自动化管理的过程都交给脚本处理，其中包括了：

通过 GitHub Actions，自动每周检查 ESLint 及相关插件是否有新版本，新版本中是否有新规则需要我们添加
自动检查我们的规则是否包含了 Prettier 的规则
自动检查我们的规则是否包含了已废弃（deprecated）的规则

除此之外，通过自动化的脚本，我们甚至可以将成百上千个 ESLint 配置文件分而治之，每个规则在一个单独的目录下管理：

通过脚本将单个的配置整合成最终的一个配置
通过脚本将单个配置中的 description 和 reason 构建成文档[网站][]，方便大家查看
通过脚本将单个配置中的 bad.js 和 good.js 输出到[网站][]中，甚至可以直接在[网站][]中看到 bad.js 的（真实运行 ESLint 脚本后的）报错信息

这样的好处是显而易见的，测试即文档即[网站][]，我们可以只在一个地方维护规则和测试，其他工作都交给自动化脚本，极大的降低了维护的成本。简单来说，当我们有个新规则需要添加时，只需要写三个文件 test/index/another-rule/.eslintrc.js, test/index/another-rule/bad.js, test/index/another-rule/good.js 即可。

使用方法

标准规则

安装：

1npm install --save-dev eslint eslint-config-nstarter

在你的项目根目录下创建 .eslintrc.js，并将以下内容复制到文件中：

1module.exports = {
2    extends: [
3        'nstarter',
4    ],
5    env: {
6        // 这里填入你的项目用到的环境
7        // 它们预定义了不同环境的全局变量，比如：
8        //
9        // browser: true,
10        // node: true,
11        // mocha: true,
12        // jest: true
13    },
14    globals: {
15        // 这里填入你的项目需要的全局变量
16        // false 表示这个全局变量不允许被重新赋值，比如：
17        //
18        // myGlobal: false
19    },
20    rules: {
21        // 这里填入你的项目需要的个性化配置
22    }
23};

TypeScript

安装：

1npm install --save-dev eslint typescript eslint-config-nstarter

在你的项目根目录下创建 .eslintrc.js，并将以下内容复制到文件中：

1module.exports = {
2    extends: [
3        'nstarter',
4        'nstarter/typescript',
5    ],
6    env: {
7        // 这里填入你的项目用到的环境
8        // 它们预定义了不同环境的全局变量，比如：
9        //
10        // browser: true,
11        // node: true,
12        // mocha: true,
13        // jest: true
14    },
15    globals: {
16        // 这里填入你的项目需要的全局变量
17        // false 表示这个全局变量不允许被重新赋值，比如：
18        //
19        // myGlobal: false
20    },
21    rules: {
22        // 这里填入你的项目需要的个性化配置
23    }
24};

Troubleshootings

在 VSCode 中使用

在 VSCode 中，默认 ESLint 并不能识别 .ts 文件，需要在「文件 => 首选项 => 设置」里做如下配置：

1{
2    "eslint.validate": [
3        "javascript",
4        "typescript"
5    ]
6}

VSCode 中的 autoFixOnSave 没有效果

如果需要针对 .ts 文件开启 ESLint 的 autoFix，则需要配置成：

1{
2    "eslint.autoFixOnSave": true,
3    "eslint.validate": [
4        "javascript",
5        {
6            "language": "typescript",
7            "autoFix": true
8        }
9    ]
10}

Testing

1npm test

常用命令

1# 安装依赖
2npm install
3
4# 构建 eslintrc 配置
5npm run build
6
7# 执行测试
8npm test
9
10# 自动修复格式错误
11npm run prettier:fix
12
13# 发布新版本
14npm version <major|minor|patch>
15git push --follow-tags
16npm publish

参考

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

SAST

Determines if the project uses static code analysis.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

License

Determines if the project has defined a license.

0

Fuzzing

Determines if the project uses fuzzing.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/jiandaoyun/nstarter-eslint-config/ci.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/jiandaoyun/nstarter-eslint-config/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/jiandaoyun/nstarter-eslint-config/ci.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/jiandaoyun/nstarter-eslint-config/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/rulesCoverage.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/jiandaoyun/nstarter-eslint-config/rulesCoverage.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/rulesCoverage.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/jiandaoyun/nstarter-eslint-config/rulesCoverage.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/rulesCoverage.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/jiandaoyun/nstarter-eslint-config/rulesCoverage.yml/master?enable=pin
Warn: containerImage not pinned by hash: Dockerfile:4
Warn: containerImage not pinned by hash: Dockerfile:13
Warn: containerImage not pinned by hash: Dockerfile:17
Warn: npmCommand not pinned by hash: Dockerfile:10
Warn: npmCommand not pinned by hash: .github/workflows/ci.yml:24
Warn: npmCommand not pinned by hash: .github/workflows/rulesCoverage.yml:30
Info: 0 out of 4 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 3 third-party GitHubAction dependencies pinned
Info: 0 out of 3 containerImage dependencies pinned
Info: 0 out of 3 npmCommand dependencies pinned

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.4

/10

Last Scanned on 2025-02-03

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

eslint-config-nstarter

Installations

Developer Guide

No

CommonJS

20.16.0

10.8.1

Score

Pull Requests

0

20

20

Issues

0

0

0

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

Languages

Developer

jiandaoyun

Download Statistics

GitHub Statistics

Bundle Size

175.00 B

151.00 B

Maintainers

Package Meta Information

Total Downloads

5,294

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

NStarter ESLint 规则

规则列表

设计理念

传承 [ESLint 的理念][]，帮助大家建立自己的规则

高度的自动化：先进的规则管理，测试即文档即[网站][]

使用方法

标准规则

TypeScript

Troubleshootings

在 VSCode 中使用

VSCode 中的 autoFixOnSave 没有效果

Testing

常用命令

参考

10

10

0

0

0

0

0

0

0

0

0

0

2.4

/10