Skip to content

Commit 7be4c2e

Browse files
chore: added npm-package-json-lint in lint:package (#52)
* chore: added npm-package-json-lint in lint:package * Added package.yml workflow * Add back description
1 parent f886d4d commit 7be4c2e

File tree

4 files changed

+130
-2
lines changed

4 files changed

+130
-2
lines changed

.github/workflows/package.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: Lint Package
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
9+
jobs:
10+
package:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v3
14+
- uses: ./.github/actions/prepare
15+
- run: yarn lint:package

.npmpackagejsonlintrc.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"extends": "npm-package-json-lint-config-default",
3+
"rules": {
4+
"require-description": "error",
5+
"require-license": "error"
6+
}
7+
}

package.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818
"husky": ">=6",
1919
"lint-staged": ">=10",
2020
"markdownlint-cli": "^0.32.2",
21+
"npm-package-json-lint": "^6.3.0",
22+
"npm-package-json-lint-config-default": "^5.0.0",
2123
"prettier": "^2.7.1",
2224
"semantic-release": "^19.0.5",
2325
"ts-prune": "^0.10.3",
@@ -33,6 +35,7 @@
3335
"build": "tsc",
3436
"format:write": "yarn format --write",
3537
"format": "prettier \"**/*\" --ignore-unknown",
38+
"lint:package": "npmPkgJsonLint .",
3639
"lint:md": "npx markdownlint \"**/*.md\" \".github/**/*.md\"",
3740
"lint:prune": "ts-prune",
3841
"lint:spelling": "cspell \"**\" \".github/**/*\"",

yarn.lock

Lines changed: 105 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -989,7 +989,12 @@ aggregate-error@^3.0.0:
989989
clean-stack "^2.0.0"
990990
indent-string "^4.0.0"
991991

992-
ajv@^6.10.0, ajv@^6.12.4:
992+
ajv-errors@^1.0.1:
993+
version "1.0.1"
994+
resolved "https://registry.yarnpkg.com/ajv-errors/-/ajv-errors-1.0.1.tgz#f35986aceb91afadec4102fbd85014950cefa64d"
995+
integrity sha512-DCRfO/4nQ+89p/RK43i8Ezd41EqdGIU4ld7nGF8OQ14oc/we5rEntLCUa7+jrn3nn83BosfwZA0wb4pon2o8iQ==
996+
997+
ajv@^6.10.0, ajv@^6.12.4, ajv@^6.12.6:
993998
version "6.12.6"
994999
resolved "https://registry.yarnpkg.com/ajv/-/ajv-6.12.6.tgz#baf5a62e802b07d977034586f8c3baf5adf26df4"
9951000
integrity sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==
@@ -1169,6 +1174,11 @@ braces@^3.0.2:
11691174
dependencies:
11701175
fill-range "^7.0.1"
11711176

1177+
builtins@^1.0.3:
1178+
version "1.0.3"
1179+
resolved "https://registry.yarnpkg.com/builtins/-/builtins-1.0.3.tgz#cb94faeb61c8696451db36534e1422f94f0aee88"
1180+
integrity sha512-uYBjakWipfaO/bXI7E8rq6kpwHRZK5cNYrUv2OzZSI/FvmdMyXJ2tG9dKcjEC5YHmHpUAwsargWIZNWdxb/bnQ==
1181+
11721182
builtins@^5.0.0:
11731183
version "5.0.1"
11741184
resolved "https://registry.yarnpkg.com/builtins/-/builtins-5.0.1.tgz#87f6db9ab0458be728564fa81d876d8d74552fa9"
@@ -1659,7 +1669,7 @@ decamelize-keys@^1.1.0:
16591669
decamelize "^1.1.0"
16601670
map-obj "^1.0.0"
16611671

1662-
decamelize@^1.1.0:
1672+
decamelize@^1.1.0, decamelize@^1.2.0:
16631673
version "1.2.0"
16641674
resolved "https://registry.yarnpkg.com/decamelize/-/decamelize-1.2.0.tgz#f6534d15148269b20352e7bee26f501f9a191290"
16651675
integrity sha512-z2S+W9X73hAUUki+N+9Za2lBlun89zigOyGrsax+KUQ6wKW4ZoWpEYBkGhQjwAjjDCkWxhY0VKEhk8wzY7F5cA==
@@ -2634,6 +2644,11 @@ ip@^2.0.0:
26342644
resolved "https://registry.yarnpkg.com/ip/-/ip-2.0.0.tgz#4cf4ab182fee2314c75ede1276f8c80b479936da"
26352645
integrity sha512-WKa+XuLG1A1R0UWhl2+1XQSi+fZWMsYKffMZTTYsiZaUD8k2yDAj5atimTUD2TZkyCkNEeYE5NhFZmupOGtjYQ==
26362646

2647+
irregular-plurals@^3.2.0:
2648+
version "3.3.0"
2649+
resolved "https://registry.yarnpkg.com/irregular-plurals/-/irregular-plurals-3.3.0.tgz#67d0715d4361a60d9fd9ee80af3881c631a31ee2"
2650+
integrity sha512-MVBLKUTangM3EfRPFROhmWQQKRDsrgI83J8GS3jXy+OwYqiR2/aoWndYQ5416jLE3uaGgLH7ncme3X9y09gZ3g==
2651+
26372652
is-arrayish@^0.2.1:
26382653
version "0.2.1"
26392654
resolved "https://registry.yarnpkg.com/is-arrayish/-/is-arrayish-0.2.1.tgz#77c99840527aa8ecb1a8ba697b80645a7a926a9d"
@@ -2705,6 +2720,11 @@ is-plain-obj@^1.1.0:
27052720
resolved "https://registry.yarnpkg.com/is-plain-obj/-/is-plain-obj-1.1.0.tgz#71a50c8429dfca773c92a390a4a03b39fcd51d3e"
27062721
integrity sha512-yvkRyxmFKEOQ4pNXCmJG5AEQNlXJS5LaONXo5/cLdTZdWvsZ1ioJEonLGAosKlMWE8lwUy/bJzMjcw8az73+Fg==
27072722

2723+
is-plain-obj@^3.0.0:
2724+
version "3.0.0"
2725+
resolved "https://registry.yarnpkg.com/is-plain-obj/-/is-plain-obj-3.0.0.tgz#af6f2ea14ac5a646183a5bbdb5baabbc156ad9d7"
2726+
integrity sha512-gwsOE28k+23GP1B6vFl1oVh/WOzmawBrKwo5Ev6wMKzPkaXaCDIQKzLnvsA42DRlbVTWorkgTKIviAKCWkfUwA==
2727+
27082728
is-plain-object@^5.0.0:
27092729
version "5.0.0"
27102730
resolved "https://registry.yarnpkg.com/is-plain-object/-/is-plain-object-5.0.0.tgz#4427f50ab3429e9025ea7d52e9043a9ef4159344"
@@ -2732,6 +2752,11 @@ is-typedarray@^1.0.0:
27322752
resolved "https://registry.yarnpkg.com/is-typedarray/-/is-typedarray-1.0.0.tgz#e479c80858df0c1b11ddda6940f96011fcda4a9a"
27332753
integrity sha512-cyA56iCMHAh5CdzjJIa4aohJyeO1YbwLi3Jc35MmRU6poroFjIGZzUzupGiRPOjgHg9TLu43xbpwXk523fMxKA==
27342754

2755+
is-unicode-supported@^0.1.0:
2756+
version "0.1.0"
2757+
resolved "https://registry.yarnpkg.com/is-unicode-supported/-/is-unicode-supported-0.1.0.tgz#3f26c76a809593b52bfa2ecb5710ed2779b522a7"
2758+
integrity sha512-knxG2q4UC3u8stRGyAVJCOdxFmv5DZiRcdlIaAQXAbSfJya+OhopNotLQrstBhququ4ZpuKbDc/8S6mgXgPFPw==
2759+
27352760
isarray@~1.0.0:
27362761
version "1.0.0"
27372762
resolved "https://registry.yarnpkg.com/isarray/-/isarray-1.0.0.tgz#bb935d48582cba168c06834957a54a3e07124f11"
@@ -2815,6 +2840,11 @@ json5@^2.1.3:
28152840
resolved "https://registry.yarnpkg.com/json5/-/json5-2.2.1.tgz#655d50ed1e6f95ad1a3caababd2b0efda10b395c"
28162841
integrity sha512-1hqLFMSrGHRHxav9q9gNjJ5EXznIxGVO09xQRrwplcS8qs28pZ8s8hupZAmqDwZUmVZ2Qb2jnyPOWcDH8m8dlA==
28172842

2843+
jsonc-parser@^3.0.0:
2844+
version "3.2.0"
2845+
resolved "https://registry.yarnpkg.com/jsonc-parser/-/jsonc-parser-3.2.0.tgz#31ff3f4c2b9793f89c67212627c51c6394f88e76"
2846+
integrity sha512-gfFQZrcTc8CnKXp6Y4/CBT3fTc0OVuDofpre4aEeEpSBPV5X5v4+Vmx+8snU7RLPrNHPKSgLxGo9YuQzz20o+w==
2847+
28182848
jsonc-parser@~3.1.0:
28192849
version "3.1.0"
28202850
resolved "https://registry.yarnpkg.com/jsonc-parser/-/jsonc-parser-3.1.0.tgz#73b8f0e5c940b83d03476bc2e51a20ef0932615d"
@@ -3097,6 +3127,14 @@ lodash@^4.17.15, lodash@^4.17.21, lodash@^4.17.4:
30973127
resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.21.tgz#679591c564c3bffaae8454cf0b3df370c3d6911c"
30983128
integrity sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==
30993129

3130+
log-symbols@^4.1.0:
3131+
version "4.1.0"
3132+
resolved "https://registry.yarnpkg.com/log-symbols/-/log-symbols-4.1.0.tgz#3fbdbb95b4683ac9fc785111e792e558d4abd503"
3133+
integrity sha512-8XPvpAA8uyhfteu8pIvQxpJZ7SYYdpUivZpGy6sFsBuKRY/7rQGavedeB8aK+Zkyq6upMFVL/9AW6vOYzfRyLg==
3134+
dependencies:
3135+
chalk "^4.1.0"
3136+
is-unicode-supported "^0.1.0"
3137+
31003138
log-update@^4.0.0:
31013139
version "4.0.0"
31023140
resolved "https://registry.yarnpkg.com/log-update/-/log-update-4.0.0.tgz#589ecd352471f2a1c0c570287543a64dfd20e0a1"
@@ -3243,6 +3281,24 @@ meow@^8.0.0:
32433281
type-fest "^0.18.0"
32443282
yargs-parser "^20.2.3"
32453283

3284+
meow@^9.0.0:
3285+
version "9.0.0"
3286+
resolved "https://registry.yarnpkg.com/meow/-/meow-9.0.0.tgz#cd9510bc5cac9dee7d03c73ee1f9ad959f4ea364"
3287+
integrity sha512-+obSblOQmRhcyBt62furQqRAQpNyWXo8BuQ5bN7dG8wmwQ+vwHKp/rCFD4CrTP8CsDQD1sjoZ94K417XEUk8IQ==
3288+
dependencies:
3289+
"@types/minimist" "^1.2.0"
3290+
camelcase-keys "^6.2.2"
3291+
decamelize "^1.2.0"
3292+
decamelize-keys "^1.1.0"
3293+
hard-rejection "^2.1.0"
3294+
minimist-options "4.1.0"
3295+
normalize-package-data "^3.0.0"
3296+
read-pkg-up "^7.0.1"
3297+
redent "^3.0.0"
3298+
trim-newlines "^3.0.0"
3299+
type-fest "^0.18.0"
3300+
yargs-parser "^20.2.3"
3301+
32463302
merge-stream@^2.0.0:
32473303
version "2.0.0"
32483304
resolved "https://registry.yarnpkg.com/merge-stream/-/merge-stream-2.0.0.tgz#52823629a14dd00c9770fb6ad47dc6310f2c1f60"
@@ -3567,6 +3623,34 @@ npm-package-arg@^9.0.0, npm-package-arg@^9.0.1, npm-package-arg@^9.1.0:
35673623
semver "^7.3.5"
35683624
validate-npm-package-name "^4.0.0"
35693625

3626+
npm-package-json-lint-config-default@^5.0.0:
3627+
version "5.0.0"
3628+
resolved "https://registry.yarnpkg.com/npm-package-json-lint-config-default/-/npm-package-json-lint-config-default-5.0.0.tgz#1bc0a12b6a5c5c03c3499b3f97be4c977f80647b"
3629+
integrity sha512-guf+bECFtVz6sekPBmkf/m/k8gbX16F5S9wZI6cvhrkSEl+AhM2GoCU6alOhbaGbkn0PgbNRcRrsuu4jWEZFHQ==
3630+
3631+
npm-package-json-lint@^6.3.0:
3632+
version "6.3.0"
3633+
resolved "https://registry.yarnpkg.com/npm-package-json-lint/-/npm-package-json-lint-6.3.0.tgz#25cd21782b34a3bd40e7568ddccfcc4a938fed5e"
3634+
integrity sha512-wOCWHSssQUzNvo85NYZweec5SNr9LtkB9tQzjOHjucoABJivtkOLcH/A/cfp6X+cPAC8UNzRC0K08HCm7G+rTA==
3635+
dependencies:
3636+
ajv "^6.12.6"
3637+
ajv-errors "^1.0.1"
3638+
chalk "^4.1.2"
3639+
cosmiconfig "^7.0.1"
3640+
debug "^4.3.4"
3641+
globby "^11.1.0"
3642+
ignore "^5.2.0"
3643+
is-plain-obj "^3.0.0"
3644+
jsonc-parser "^3.0.0"
3645+
log-symbols "^4.1.0"
3646+
meow "^9.0.0"
3647+
plur "^4.0.0"
3648+
semver "^7.3.5"
3649+
slash "^3.0.0"
3650+
strip-json-comments "^3.1.1"
3651+
type-fest "^2.12.0"
3652+
validate-npm-package-name "^3.0.0"
3653+
35703654
npm-packlist@^5.1.0:
35713655
version "5.1.3"
35723656
resolved "https://registry.yarnpkg.com/npm-packlist/-/npm-packlist-5.1.3.tgz#69d253e6fd664b9058b85005905012e00e69274b"
@@ -3992,6 +4076,13 @@ pkg-conf@^2.1.0:
39924076
find-up "^2.0.0"
39934077
load-json-file "^4.0.0"
39944078

4079+
plur@^4.0.0:
4080+
version "4.0.0"
4081+
resolved "https://registry.yarnpkg.com/plur/-/plur-4.0.0.tgz#729aedb08f452645fe8c58ef115bf16b0a73ef84"
4082+
integrity sha512-4UGewrYgqDFw9vV6zNV+ADmPAUAfJPKtGvb/VdpQAx25X5f3xXdGdyOEVFwkl8Hl/tl7+xbeHqSEM+D5/TirUg==
4083+
dependencies:
4084+
irregular-plurals "^3.2.0"
4085+
39954086
postcss-selector-parser@^6.0.10:
39964087
version "6.0.10"
39974088
resolved "https://registry.yarnpkg.com/postcss-selector-parser/-/postcss-selector-parser-6.0.10.tgz#79b61e2c0d1bfc2602d549e11d0876256f8df88d"
@@ -4854,6 +4945,11 @@ type-fest@^1.0.2:
48544945
resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-1.4.0.tgz#e9fb813fe3bf1744ec359d55d1affefa76f14be1"
48554946
integrity sha512-yGSza74xk0UG8k+pLh5oeoYirvIiWo5t0/o3zHHAO2tRDiZcxWP7fywNlXhqb6/r6sWvwi+RsyQMWhVLe4BVuA==
48564947

4948+
type-fest@^2.12.0:
4949+
version "2.19.0"
4950+
resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-2.19.0.tgz#88068015bb33036a598b952e55e9311a60fd3a9b"
4951+
integrity sha512-RAH822pAdBgcNMAfWnCBU3CFZcfZ/i1eZjwFU/dsLKumyuuP3niueg2UAukXYF0E2AAoc82ZSSf9J0WQBinzHA==
4952+
48574953
typedarray-to-buffer@^3.1.5:
48584954
version "3.1.5"
48594955
resolved "https://registry.yarnpkg.com/typedarray-to-buffer/-/typedarray-to-buffer-3.1.5.tgz#a97ee7a9ff42691b9f783ff1bc5112fe3fca9080"
@@ -4932,6 +5028,13 @@ validate-npm-package-license@^3.0.1, validate-npm-package-license@^3.0.4:
49325028
spdx-correct "^3.0.0"
49335029
spdx-expression-parse "^3.0.0"
49345030

5031+
validate-npm-package-name@^3.0.0:
5032+
version "3.0.0"
5033+
resolved "https://registry.yarnpkg.com/validate-npm-package-name/-/validate-npm-package-name-3.0.0.tgz#5fa912d81eb7d0c74afc140de7317f0ca7df437e"
5034+
integrity sha512-M6w37eVCMMouJ9V/sdPGnC5H4uDr73/+xdq0FBLO3TFFX1+7wiUY6Es328NN+y43tmY+doUdN9g9J21vqB7iLw==
5035+
dependencies:
5036+
builtins "^1.0.3"
5037+
49355038
validate-npm-package-name@^4.0.0:
49365039
version "4.0.0"
49375040
resolved "https://registry.yarnpkg.com/validate-npm-package-name/-/validate-npm-package-name-4.0.0.tgz#fe8f1c50ac20afdb86f177da85b3600f0ac0d747"

0 commit comments

Comments
 (0)