-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(npm-package-json-lint-config): npm-package-json-lint config
- Loading branch information
Showing
12 changed files
with
327 additions
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "extends": [ | ||
| "@trigen/npm-package-json-lint-config", | ||
| "@trigen/npm-package-json-lint-config/monorepo" | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "extends": [ | ||
| "@trigen/eslint-config/commonjs" | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| # @trigen/npm-package-json-lint-config | ||
|
|
||
| [![NPM version][npm]][npm-url] | ||
| [![Node version][node]][node-url] | ||
| [![Dependencies status][deps]][deps-url] | ||
| [![Build status][build]][build-url] | ||
|
|
||
| [npm]: https://img.shields.io/npm/v/%40trigen/npm-package-json-lint-config.svg | ||
| [npm-url]: https://npmjs.com/package/@trigen/npm-package-json-lint-config | ||
|
|
||
| [node]: https://img.shields.io/node/v/%40trigen/npm-package-json-lint-config.svg | ||
| [node-url]: https://nodejs.org | ||
|
|
||
| [deps]: https://img.shields.io/librariesio/release/npm/@trigen/npm-package-json-lint-config | ||
| [deps-url]: https://libraries.io/npm/@trigen%2Feslint-config/tree | ||
|
|
||
| [build]: https://img.shields.io/github/workflow/status/TrigenSoftware/scripts/CI.svg | ||
| [build-url]: https://github.com/TrigenSoftware/scripts/actions | ||
|
|
||
| Trigen's npm-package-json-lint config. | ||
|
|
||
| ## Install | ||
|
|
||
| ```bash | ||
| pnpm add -D @trigen/npm-package-json-lint-config | ||
| # or | ||
| yarn add -D @trigen/npm-package-json-lint-config | ||
| # or | ||
| npm i -D @trigen/npm-package-json-lint-config | ||
| ``` | ||
|
|
||
| ## Configure | ||
|
|
||
| Create `.npmpackagejsonlintrc.json` with next content: | ||
|
|
||
| ```json | ||
| { | ||
| "extends": "@trigen/npm-package-json-lint-config" | ||
| } | ||
| ``` | ||
|
|
||
| for monorepos: | ||
|
|
||
| ```json | ||
| { | ||
| "extends": [ | ||
| "@trigen/npm-package-json-lint-config", | ||
| "@trigen/npm-package-json-lint-config/monorepo" | ||
| ] | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| { | ||
| "name": "@trigen/npm-package-json-lint-config", | ||
| "version": "8.0.0-alpha.3", | ||
| "description": "Trigen's npm-package-json-lint config.", | ||
| "author": "dangreen", | ||
| "license": "MIT", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "https://github.com/TrigenSoftware/scripts.git", | ||
| "directory": "packages/npm-package-json-lint-config" | ||
| }, | ||
| "bugs": { | ||
| "url": "https://github.com/TrigenSoftware/scripts/issues" | ||
| }, | ||
| "keywords": [ | ||
| "npm-package-json-lint", | ||
| "npm-package-json-lint-config" | ||
| ], | ||
| "engines": { | ||
| "node": ">=10" | ||
| }, | ||
| "main": "./src/index.js", | ||
| "exports": { | ||
| ".": "./src/index.js", | ||
| "./*": "./src/*.js" | ||
| }, | ||
| "publishConfig": { | ||
| "access": "public", | ||
| "directory": "package" | ||
| }, | ||
| "scripts": { | ||
| "prepublishOnly": "del ./package && clean-publish", | ||
| "postpublish": "del ./package" | ||
| }, | ||
| "peerDependencies": { | ||
| "npm-package-json-lint": ">= 2" | ||
| }, | ||
| "dependencies": { | ||
| "npm-package-json-lint-config-default": "^3.0.0" | ||
| }, | ||
| "readme": "" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| module.exports = { | ||
| extends: 'npm-package-json-lint-config-default', | ||
| rules: { | ||
| 'require-author': 'error', | ||
| 'require-bugs': 'error', | ||
| 'require-description': 'error', | ||
| 'require-keywords': 'error', | ||
| 'require-license': 'error', | ||
| 'require-repository': 'error', | ||
| 'no-repeated-dependencies': 'error', | ||
| 'description-format': [ | ||
| 'error', | ||
| { | ||
| requireCapitalFirstLetter: true, | ||
| requireEndingPeriod: true | ||
| } | ||
| ], | ||
| 'name-format': 'error', | ||
| 'version-format': 'error', | ||
| 'no-duplicate-properties': 'error', | ||
| 'prefer-no-engineStrict': 'error', | ||
| 'prefer-property-order': [ | ||
| 'error', | ||
| [ | ||
| 'name', | ||
| 'type', | ||
| 'private', | ||
| 'version', | ||
| 'description', | ||
| 'author', | ||
| 'authors', | ||
| 'license', | ||
| 'homepage', | ||
| 'repository', | ||
| 'bugs', | ||
| 'keywords', | ||
| 'engines', | ||
| 'bin', | ||
| 'sideEffects', | ||
| 'types', | ||
| 'main', | ||
| 'module', | ||
| 'umd', | ||
| 'exports', | ||
| 'publishConfig', | ||
| 'files', | ||
| 'scripts', | ||
| 'peerDependencies', | ||
| 'dependencies', | ||
| 'devDependencies', | ||
| 'workspaces', | ||
| 'tsd', | ||
| 'readme' | ||
| ] | ||
| ] | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| const base = require('.') | ||
|
|
||
| module.exports = { | ||
| rules: { | ||
| 'require-keywords': 'off', | ||
| 'require-private': 'error', | ||
| 'valid-values-private': ['error', [true]] | ||
| }, | ||
| overrides: [ | ||
| { | ||
| patterns: ['packages/*/package.json'], | ||
| rules: { | ||
| 'require-private': 'off', | ||
| 'valid-values-private': 'off', | ||
| 'require-repository-directory': 'error', | ||
| ...base.rules | ||
| } | ||
| } | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.