fix: expose FilterXYSchema.json in exports (#27)

Also fixes the readme with correct links.

BREAKING-CHANGE: The JSON schema must now be imported like this: `import filterXY from 'ml-signal-processing/FilterXYSchema.json' with { type: 'json' };`

Author: targos

.gitignore

@@ -1,4 +1,3 @@
-FilterXYSchema.js
 FilterXYSchema.json
 
 # Logs

.prettierignore

@@ -2,4 +2,3 @@ CHANGELOG.md
 lib
 coverage
 FilterXYSchema.json
-FilterXYSchema.js

FilterXYSchema.d.ts

@@ -1,15 +1,17 @@
-# signal-processing
+# ml-signal-processing
 
-[![NPM version][npm-image]][npm-url]
-[![build status][ci-image]][ci-url]
-[![Test coverage][codecov-image]][codecov-url]
-[![npm download][download-image]][download-url]
+[![NPM version](https://img.shields.io/npm/v/ml-signal-processing.svg)](https://www.npmjs.com/package/ml-signal-processing)
+[![npm download](https://img.shields.io/npm/dm/ml-signal-processing.svg)](https://www.npmjs.com/package/ml-signal-processing)
+[![test coverage](https://img.shields.io/codecov/c/github/mljs/signal-processing.svg)](https://codecov.io/gh/mljs/signal-processing)
+[![license](https://img.shields.io/npm/l/ml-signal-processing.svg)](https://github.com/mljs/signal-processing/blob/main/LICENSE)
 
 Process data in the form of {x:[], y:[]}.
 
 ## Installation
 
-`$ npm i signal-processing`
+```console
+npm install ml-signal-processing
+```
 
 ## Usage
 
@@ -38,12 +40,3 @@ const result = filterXY(data, filters);
 ## License
 
 [MIT](./LICENSE)
-
-[npm-image]: https://img.shields.io/npm/v/signal-processing.svg
-[npm-url]: https://www.npmjs.com/package/signal-processing
-[ci-image]: https://github.com/cheminfo/signal-processing/workflows/Node.js%20CI/badge.svg?branch=main
-[ci-url]: https://github.com/cheminfo/signal-processing/actions?query=workflow%3A%22Node.js+CI%22
-[codecov-image]: https://img.shields.io/codecov/c/github/cheminfo/signal-processing.svg
-[codecov-url]: https://codecov.io/gh/cheminfo/signal-processing
-[download-image]: https://img.shields.io/npm/dm/signal-processing.svg
-[download-url]: https://www.npmjs.com/package/signal-processing

README.md

@@ -1,7 +1,4 @@
 import { defineConfig, globalIgnores } from 'eslint/config';
 import cheminfo from 'eslint-config-cheminfo-typescript';
 
-export default defineConfig(
-  globalIgnores(['coverage', 'lib', 'FilterXYSchema.*']),
-  cheminfo,
-);
+export default defineConfig(globalIgnores(['coverage', 'lib']), cheminfo);

eslint.config.mjs renamed to eslint.config.js

@@ -3,22 +3,22 @@
   "version": "1.2.0",
   "description": "Process data in the form of {x:[], y:[]}",
   "type": "module",
-  "exports": "./lib/index.js",
+  "exports": {
+    ".": "./lib/index.js",
+    "./FilterXYSchema.json": "./FilterXYSchema.json"
+  },
   "keywords": [],
   "author": "Luc Patiny",
   "license": "MIT",
   "files": [
     "src",
     "lib",
-    "FilterXYSchema.d.ts",
-    "FilterXYSchema.js",
     "FilterXYSchema.json"
   ],
   "scripts": {
     "check-types": "tsc --noEmit",
     "clean": "rimraf lib",
     "createSchema": "typescript-json-schema --refs false ./tsconfig.json FilterXYType > FilterXYSchema.json",
-    "postcreateSchema": "node scripts/create_js_schema.mjs",
     "eslint": "eslint . --cache",
     "eslint-fix": "node --run eslint -- --fix",
     "prepack": "npm run createSchema && npm run tsc",
@@ -39,7 +39,7 @@
   "homepage": "https://github.com/mljs/signal-processing#readme",
   "devDependencies": {
     "@vitest/coverage-v8": "^3.2.3",
-    "@zakodium/tsconfig": "^1.0.1",
+    "@zakodium/tsconfig": "^1.0.2",
     "eslint": "^9.29.0",
     "eslint-config-cheminfo-typescript": "^18.0.1",
     "jest-matcher-deep-close-to": "^3.0.2",

package.json

@@ -2,8 +2,7 @@
   "extends": "@zakodium/tsconfig",
   "compilerOptions": {
     "outDir": "lib",
-    "noUncheckedIndexedAccess": false,
-    "allowImportingTsExtensions": true
+    "noUncheckedIndexedAccess": false
   },
   "include": ["src", "vite*.ts"]
 }