chore: update project structure

unional · Apr 24, 2022 · 805b4c6 · 805b4c6
1 parent 38b6ed8
commit 805b4c6
Show file tree

Hide file tree

Showing 38 changed files with 1,011 additions and 300 deletions.
diff --git a/.depcheckrc.yml b/.depcheckrc.yml
@@ -0,0 +1,5 @@
+ignores:
+  - "@commitlint/*"
+  - "@size-limit/*"
+  - "@types/jest"
+  - typedoc*
diff --git a/.gitignore b/.gitignore
@@ -42,8 +42,9 @@ node_modules
 .idea
 
 # project folders
-dist*
-lib*
-out*
 cjs
+dist
+docs
 esm
+lib
+out
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -10,6 +10,7 @@
   ],
   "eslint.enable": true,
   "cSpell.words": [
+    "codeql",
     "jsnext",
     "tersible",
     "tersify"

diff --git a/jest.config.js b/jest.config.js
@@ -1,39 +1,13 @@
-const isCI = require('is-ci')
-module.exports = isCI ? {
-  'collectCoverageFrom': [
-    '<rootDir>/src/**/*.[jt]s',
-    '!<rootDir>/src/bin.[jt]s',
-    '!<rootDir>/src/type-checker/*'
+module.exports = {
+  collectCoverageFrom: [
+    '<rootDir>/ts/**/*.[jt]s'
   ],
-  'roots': [
-    '<rootDir>/src',
+  roots: [
+    '<rootDir>/ts',
   ],
-  'reporters': [
-    'default',
-    [
-      'jest-junit',
-      {
-        'output': '.reports/junit/js-test-results.xml',
-      },
-    ],
-  ],
-  'testEnvironment': 'node',
-  'testMatch': ['**/?(*.)+(spec|test|integrate|accept|system|unit).[jt]s?(x)'],
-} : {
-  'collectCoverageFrom': [
-    '<rootDir>/src/**/*.[jt]s'
-  ],
-  'reporters': [
-    'default',
-    'jest-progress-tracker',
-    // ['jest-audio-reporter', { volume: 0.3 }],
-  ],
-  'roots': [
-    '<rootDir>/src',
-  ],
-  'testEnvironment': 'node',
-  'testMatch': ['**/?(*.)+(spec|test|integrate|accept|system|unit).[jt]s?(x)'],
-  'watchPlugins': [
+  testEnvironment: 'node',
+  testMatch: ['**/?(*.)+(spec|test|integrate|accept|system|unit).[jt]s?(x)'],
+  watchPlugins: [
     'jest-watch-suspend',
     'jest-watch-typeahead/filename',
     'jest-watch-typeahead/testname',

diff --git a/package.json b/package.json
@@ -15,23 +15,26 @@
     "name": "Homa Wong (unional)",
     "email": "[email protected]"
   },
-  "main": "cjs/index.js",
-  "module": "esm/index.js",
-  "jsnext:main": "esm/index.js",
-  "typings": "cjs/index.d.ts",
+  "main": "lib/index.js",
+  "typings": "lib/index.d.ts",
   "files": [
-    "cjs",
-    "esm",
-    "src"
+    "lib"
   ],
   "scripts": {
-    "build": "tsc -p tsconfig.es5.json && tsc -p tsconfig.esnext.json",
-    "clean": "rimraf lib esm",
+    "build": "tsc -p tsconfig.build.json",
+    "build:doc": "typedoc",
+    "clean": "rimraf cjs lib esm coverage",
     "coverage": "jest --coverage",
-    "dependency-check": "dependency-check . --unused --no-dev && dependency-check . --missing --no-dev",
+    "depcheck": "depcheck",
     "lint": "eslint --ext=js,ts .",
-    "test": "jest --reporters=default",
-    "verify": "yarn lint && yarn build && yarn dependency-check && jest --coverage --reporters=default",
+    "nuke": "yarn clean && rimraf node_modules",
+    "prepare": "husky install",
+    "release": "npx semantic-release",
+    "size-limit": "size-limit",
+    "test": "jest",
+    "test:types": "tsc",
+    "verify": "run-p verify:build lint test:types coverage",
+    "verify:build": "npm-run-all clean build -p depcheck size-limit",
     "watch": "jest --watch",
     "watch:type": "tsc --watch"
   },
@@ -40,28 +43,35 @@
   },
   "devDependencies": {
     "@babel/core": "7.17.9",
-    "@babel/plugin-proposal-class-properties": "7.16.7",
-    "@babel/plugin-proposal-nullish-coalescing-operator": "7.16.7",
-    "@babel/plugin-proposal-optional-chaining": "7.16.7",
     "@babel/preset-env": "7.16.11",
     "@babel/preset-typescript": "7.16.7",
     "@commitlint/cli": "^16.2.3",
     "@commitlint/config-conventional": "^16.2.1",
+    "@size-limit/preset-small-lib": "^7.0.8",
     "@types/jest": "27.4.1",
     "@typescript-eslint/eslint-plugin": "^5.20.0",
     "assertron": "9.0.5",
-    "dependency-check": "^4.1.0",
+    "depcheck": "^1.4.3",
     "eslint": "8.14.0",
     "eslint-plugin-harmony": "^6.0.3",
     "husky": "^7.0.4",
     "is-ci": "^3.0.1",
     "jest": "27.5.1",
-    "jest-junit": "^13.2.0",
     "jest-validate": "27.5.1",
     "jest-watch-suspend": "^1.1.2",
     "jest-watch-toggle-config": "^2.0.1",
     "jest-watch-typeahead": "^1.0.0",
+    "npm-run-all": "^4.1.5",
+    "rimraf": "^3.0.2",
+    "size-limit": "^7.0.8",
     "type-plus": "4.9.0",
+    "typedoc": "^0.22.15",
+    "typedoc-plugin-extras": "^2.2.3",
     "typescript": "4.6.3"
-  }
+  },
+  "size-limit": [
+    {
+      "limit": "10 kb"
+    }
+  ]
 }
diff --git a/src/anything.ts → ts/anything.ts b/src/anything.ts → ts/anything.ts
diff --git a/src/createSatisfier.spec.ts → ts/createSatisfier.spec.ts b/src/createSatisfier.spec.ts → ts/createSatisfier.spec.ts
diff --git a/src/createSatisfier.ts → ts/createSatisfier.ts b/src/createSatisfier.ts → ts/createSatisfier.ts
@@ -33,7 +33,6 @@ function diff(expected: any, actual: any, path: Diff['path'] = [], _index?: numb
     }]
   }
 
-  // tslint:disable-next-line: strict-type-predicates valid-typeof
   if (typeof expected === 'bigint') {
     return actual === expected ? noDiff : [{
       path,

diff --git a/src/every.spec.ts → ts/every.spec.ts b/src/every.spec.ts → ts/every.spec.ts
diff --git a/src/every.ts → ts/every.ts b/src/every.ts → ts/every.ts
diff --git a/src/exact.spec.ts → ts/exact.spec.ts b/src/exact.spec.ts → ts/exact.spec.ts
diff --git a/src/exact.ts → ts/exact.ts b/src/exact.ts → ts/exact.ts
diff --git a/src/formatDiffs.spec.ts → ts/formatDiffs.spec.ts b/src/formatDiffs.spec.ts → ts/formatDiffs.spec.ts
diff --git a/src/formatDiffs.ts → ts/formatDiffs.ts b/src/formatDiffs.ts → ts/formatDiffs.ts
diff --git a/src/has.spec.ts → ts/has.spec.ts b/src/has.spec.ts → ts/has.spec.ts
diff --git a/src/has.ts → ts/has.ts b/src/has.ts → ts/has.ts
diff --git a/src/index.ts → ts/index.ts b/src/index.ts → ts/index.ts
diff --git a/src/interfaces.ts → ts/interfaces.ts b/src/interfaces.ts → ts/interfaces.ts
diff --git a/src/isInInterval.spec.ts → ts/isInInterval.spec.ts b/src/isInInterval.spec.ts → ts/isInInterval.spec.ts
diff --git a/src/isInInterval.ts → ts/isInInterval.ts b/src/isInInterval.ts → ts/isInInterval.ts
diff --git a/src/isInRange.spec.ts → ts/isInRange.spec.ts b/src/isInRange.spec.ts → ts/isInRange.spec.ts
diff --git a/src/isInRange.ts → ts/isInRange.ts b/src/isInRange.ts → ts/isInRange.ts
diff --git a/src/isTypeOf.spec.ts → ts/isTypeOf.spec.ts b/src/isTypeOf.spec.ts → ts/isTypeOf.spec.ts
diff --git a/src/isTypeOf.ts → ts/isTypeOf.ts b/src/isTypeOf.ts → ts/isTypeOf.ts
diff --git a/src/none.spec.ts → ts/none.spec.ts b/src/none.spec.ts → ts/none.spec.ts
diff --git a/src/none.ts → ts/none.ts b/src/none.ts → ts/none.ts
diff --git a/src/satisfies.spec.ts → ts/satisfies.spec.ts b/src/satisfies.spec.ts → ts/satisfies.spec.ts
diff --git a/src/satisfies.ts → ts/satisfies.ts b/src/satisfies.ts → ts/satisfies.ts
diff --git a/src/some.spec.ts → ts/some.spec.ts b/src/some.spec.ts → ts/some.spec.ts
diff --git a/src/some.ts → ts/some.ts b/src/some.ts → ts/some.ts
@@ -1,11 +1,11 @@
 import { tersible, tersify } from 'tersify'
-import { createSatisfier } from './createSatisfier'
+import { createSatisfier, Expectation } from './createSatisfier'
 
 /**
  * Check if an array have at least one entry satisfying the expectation.
  * @param expectation expectation
  */
-export function some(expectation: any) {
+export function some<E extends Expectation>(expectation: E) {
   const s = createSatisfier(expectation)
   return tersible((e: any) => e && Array.isArray(e) && e.some(v => s.test(v)), () => `some(${tersify(expectation)})`)
 }
diff --git a/src/startsWith.spec.ts → ts/startsWith.spec.ts b/src/startsWith.spec.ts → ts/startsWith.spec.ts
diff --git a/src/startsWith.ts → ts/startsWith.ts b/src/startsWith.ts → ts/startsWith.ts
diff --git a/tsconfig.base.json b/tsconfig.base.json
diff --git a/tsconfig.build.json b/tsconfig.build.json
@@ -0,0 +1,30 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "declarationMap": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "lib": [
+      "DOM",
+      "ES2020"
+    ],
+    "module": "CommonJS",
+    "moduleResolution": "node",
+    "newLine": "LF",
+    "noUnusedLocals": true,
+    "noUnusedParameters": false,
+    "outDir": "lib",
+    "sourceMap": true,
+    "inlineSources": true,
+    "strict": true,
+    "stripInternal": true,
+    "target": "ES2020",
+    "useDefineForClassFields": true
+  },
+  "include": [
+    "typings"
+  ],
+  "files": [
+    "ts/index.ts"
+  ]
+}
diff --git a/tsconfig.es5.json b/tsconfig.es5.json
diff --git a/tsconfig.esnext.json b/tsconfig.esnext.json
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,7 +1,18 @@
 {
-  "extends": "./tsconfig.esnext.json",
+  "extends": "./tsconfig.build.json",
+  "compilerOptions": {
+    "noEmit": true
+  },
   "include": [
-    "src",
+    "ts",
     "typings"
-  ]
+  ],
+  "typedocOptions": {
+    "customTitle": "A purposely loose comparison tool.",
+    "customTitleLink": "https://github.com/unional/satisfier",
+    "entryPoints": [
+      "src/index.ts"
+    ],
+    "out": "docs"
+  }
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -42,8 +42,9 @@ node_modules @@
     .idea
     # project folders
-    dist*
-    lib*
-    out*
     cjs
+    dist
+    docs
     esm
+    lib
+    out