feat(npm-package-json-lint): enforce type module (#313)

spear-ai · Nov 22, 2023 · e82eaaa · e82eaaa
1 parent 0903639
commit e82eaaa
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 2 deletions.
diff --git a/.changeset/clean-buckets-tease.md b/.changeset/clean-buckets-tease.md
@@ -0,0 +1,5 @@
+---
+"@spear-ai/npm-package-json-lint-config": major
+---
+
+Added rule to NPM Package JSON Lint configs to require packages be of type `module`.
diff --git a/.changeset/thin-meals-visit.md b/.changeset/thin-meals-visit.md
@@ -0,0 +1,5 @@
+---
+"@spear-ai/npm-package-json-lint-config": patch
+---
+
+Fixed missing rules in NPM Package JSON Lint configs.
diff --git a/package.json b/package.json
@@ -23,7 +23,7 @@
     "turbo": "1.10.16",
     "typescript": "5.3.2"
   },
-  "license": "",
+  "license": "MIT",
   "packageManager": "[email protected]",
   "private": true,
   "repository": {

diff --git a/packages/npm-package-json-lint-config/src/base.ts b/packages/npm-package-json-lint-config/src/base.ts
@@ -18,10 +18,12 @@ const baseNpmPackageJsonLintConfig = {
     "prefer-alphabetical-optionalDependencies": "error",
     "prefer-alphabetical-peerDependencies": "error",
     "prefer-alphabetical-scripts": "error",
-    "prefer-property-order": ["error", []],
+    "require-author": "error",
     "require-description": "error",
     "require-license": "error",
+    "require-type": "error",
     "valid-values-license": ["error", ["MIT", "UNLICENSED"]],
+    "valid-values-type": ["error", ["module"]],
     "version-format": "error",
   },
 };

diff --git a/packages/npm-package-json-lint-config/src/spear.ts b/packages/npm-package-json-lint-config/src/spear.ts
@@ -5,6 +5,7 @@ import baseNpmPackageJsonLintConfig from "./base";
 const npmPackageJsonLintConfig = {
   ...baseNpmPackageJsonLintConfig,
   rules: {
+    ...baseNpmPackageJsonLintConfig.rules,
     "valid-values-author": ["error", ["Spear AI"]],
     "valid-values-name-scope": ["error", ["@spear-ai"]],
   },