Convert to TypeScript

Author: jdalton

.github/workflows/provenance.yml

@@ -22,5 +22,6 @@ jobs:
     with:
       debug: ${{ inputs.debug }}
       package-name: '@socketregistry/packageurl-js'
+      setup-script: 'pnpm run build'
     secrets:
       npm_token: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -10,5 +10,6 @@ Thumbs.db
 **/.cache
 **/node_modules
 /*.tsbuildinfo
+/dist
 
 !/.vscode/extensions.json

eslint.config.mjs

@@ -7,6 +7,7 @@ import {
   includeIgnoreFile,
 } from '@eslint/compat'
 import js from '@eslint/js'
+import typescriptParser from '@typescript-eslint/parser'
 import importXPlugin from 'eslint-plugin-import-x'
 import nodePlugin from 'eslint-plugin-n'
 import sortDestructureKeysPlugin from 'eslint-plugin-sort-destructure-keys'
@@ -87,6 +88,8 @@ export default [
           js: 'ignorePackages',
           json: 'always',
           mjs: 'ignorePackages',
+          mts: 'never',
+          ts: 'never',
         },
       ],
       'import-x/no-named-as-default-member': 'off',
@@ -154,9 +157,66 @@ export default [
     },
   },
   {
-    files: ['**/*.mjs'],
+    files: ['**/*.mjs', '**/*.mts'],
     languageOptions: {
       sourceType: 'module',
     },
+    rules: {
+      'import-x/extensions': ['error', 'never', { mts: 'never' }],
+    },
+  },
+  {
+    files: ['test/**/*.test.mts'],
+    languageOptions: {
+      parser: typescriptParser,
+      sourceType: 'module',
+      parserOptions: {
+        ecmaVersion: 'latest',
+        sourceType: 'module',
+      },
+    },
+    rules: {
+      'n/no-unsupported-features/es-syntax': 'off',
+      'n/no-missing-import': 'off',
+      'n/no-missing-require': 'off',
+      'import-x/no-unresolved': 'off',
+      'import-x/extensions': 'off',
+      'no-unused-vars': [
+        'error',
+        {
+          argsIgnorePattern: '^_|^this$|^context$',
+          ignoreRestSiblings: true,
+          varsIgnorePattern: '^_',
+        },
+      ],
+      'unicorn/consistent-function-scoping': 'off',
+      'no-proto': 'off',
+      'no-new': 'off',
+    },
+  },
+  {
+    files: ['**/*.ts', '**/*.mts'],
+    languageOptions: {
+      parser: typescriptParser,
+      sourceType: 'module',
+      parserOptions: {
+        ecmaVersion: 'latest',
+        sourceType: 'module',
+      },
+    },
+    rules: {
+      'n/no-unsupported-features/es-syntax': 'off',
+      'n/no-missing-import': 'off',
+      'n/no-missing-require': 'off',
+      'import-x/no-unresolved': 'off',
+      'import-x/extensions': [
+        'error',
+        'always',
+        {
+          ts: 'never',
+          mts: 'never',
+        },
+      ],
+    },
   },
-]
+]

index.js index.tsindex.js renamed to index.ts

@@ -19,18 +19,9 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 */
-'use strict'
 
-const {
-  PackageURL,
+export { PackageURL,
   PurlComponent,
   PurlQualifierNames,
   PurlType,
-} = require('./src/package-url')
-
-module.exports = {
-  PackageURL,
-  PurlComponent,
-  PurlQualifierNames,
-  PurlType,
-}
+ } from './src/package-url.js'

knip.json

@@ -1,4 +1,4 @@
 {
-  "entry": ["scripts/*.js", "src/*.{js,ts}", "test/*.test.ts", "*.js"],
+  "entry": ["scripts/*.js", "src/*.{js,mts}", "test/*.test.mts", "*.mts"],
   "project": ["scripts/**", "src/**", "test/**"]
 }

package.json

@@ -12,30 +12,19 @@
     "type": "git",
     "url": "git+https://github.com/SocketDev/socket-packageurl-js.git"
   },
+  "main": "./dist/cjs/package-url.js",
+  "types": "./dist/cjs/package-url.d.ts",
   "exports": {
     ".": {
-      "types": "./index.d.ts",
-      "default": "./index.js"
+      "types": "./dist/cjs/package-url.d.ts",
+      "default": "./dist/cjs/package-url.js"
     },
     "./data/npm/builtin-names.json": "./data/npm/builtin-names.json",
     "./data/npm/legacy-names.json": "./data/npm/legacy-names.json",
-    "./src/constants": "./src/constants.js",
-    "./src/decode": "./src/decode.js",
-    "./src/encode": "./src/encode.js",
-    "./src/error": "./src/error.js",
-    "./src/helpers": "./src/helpers.js",
-    "./src/lang": "./src/lang.js",
-    "./src/normalize": "./src/normalize.js",
-    "./src/objects": "./src/objects.js",
-    "./src/package-url": {
-      "types": "./src/package-url.d.ts",
-      "default": "./src/package-url.js"
+    "./dist/cjs/*": {
+      "types": "./dist/cjs/*.d.ts",
+      "default": "./dist/cjs/*.js"
     },
-    "./src/purl-component": "./src/purl-component.js",
-    "./src/purl-qualifier-names": "./src/purl-qualifier-names.js",
-    "./src/purl-type": "./src/purl-type.js",
-    "./src/strings": "./src/strings.js",
-    "./src/validate": "./src/validate.js",
     "./package.json": "./package.json"
   },
   "sideEffects": false,
@@ -44,7 +33,10 @@
     "check-ci": "pnpm check:lint",
     "check:lint": "eslint --report-unused-disable-directives .",
     "check:lint:fix": "pnpm check:lint --fix",
-    "check:tsc": "tsc",
+    "build": "pnpm run clean:dist && pnpm run build:cjs",
+    "build:cjs": "tsc",
+    "check:tsc": "tsc --noEmit",
+    "clean:dist": "del-cli 'dist'",
     "clean": "run-s -c clean:*",
     "clean:cache": "del-cli '**/.cache'",
     "clean:coverage": "del-cli 'coverage'",
@@ -81,6 +73,9 @@
     "@eslint/compat": "1.3.2",
     "@eslint/js": "9.35.0",
     "@socketsecurity/registry": "1.2.2",
+    "@types/node": "24.5.2",
+    "@typescript-eslint/eslint-plugin": "8.44.1",
+    "@typescript-eslint/parser": "8.44.1",
     "@vitest/coverage-v8": "3.2.4",
     "all-the-package-names": "2.0.0",
     "all-the-package-names-v1.3905.0": "npm:[email protected]",
@@ -113,9 +108,8 @@
     "pnpm": ">=10.16.0"
   },
   "files": [
-    "*{.js,.ts}",
+    "dist/**/*",
     "data/**/*.json",
-    "src/**/*{.js,.ts}",
     "CHANGELOG.md"
   ],
   "lint-staged": {