diff --git a/.github/workflows/run b/.github/workflows/run index 449ae563..6330c754 100755 --- a/.github/workflows/run +++ b/.github/workflows/run @@ -9,6 +9,7 @@ publish=false if [[ "${1}" == 'publish' ]] ; then publish=true fi +docdir='.docs' # Check for and set npm token if "${publish}" ; then @@ -16,8 +17,8 @@ if "${publish}" ; then echo 'Missing environment variable NPM_TOKEN' exit 1 else - mkdir .docs || exit 1 - cp .github/workflows/home/* .docs + mkdir "${docdir}" || exit 1 + cp .github/workflows/home/* "${docdir}" npm config set '//registry.npmjs.org/:_authToken' "${NPM_TOKEN}" fi fi @@ -117,7 +118,7 @@ for dir in */ ; do echo "packages['${package_name//"'"/"\\'"}'].time = '${package_date//"'"/"\\'"}';" echo "packages['${package_name//"'"/"\\'"}'].ver = '${local_version//"'"/"\\'"}';" echo "packages['${package_name//"'"/"\\'"}'].dir = '${dir//"'"/"\\'"}';" - } >> '../.docs/index.js' + } >> "../${docdir}/index.js" # Copy over the template readme file and replace variables echo 'Generating readme...' cp '../.github/workflows/template.md' README.md @@ -144,8 +145,8 @@ for dir in */ ; do # package generates documentation, then it will # overwrite the GH pages archive with that dir only echo 'Generating documentation...' - npm run docs || exit 1 - mv docs "../.docs/${dir}" + npm run build || exit 1 + mv docs "../${docdir}/${dir}" # Reset the readme file to its original state echo "${readme}" > README.md fi diff --git a/README.md b/README.md index ee35e0bb..f3c9c1be 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,8 @@ nicfv's public NPM packages in one repository ## Developer Notes - Each package must have the following scripts + - `build` - `test` - - `docs` - `clean` - Something to compile on `npm publish` - Each package must contain `README.md` and `CHANGELOG.md` diff --git a/datafit/CHANGELOG.md b/datafit/CHANGELOG.md index e24d56ed..1d26c2ed 100644 --- a/datafit/CHANGELOG.md +++ b/datafit/CHANGELOG.md @@ -1,5 +1,15 @@ # Changelog +## 1.4.3 + +- Update dependency versions +- Minor documentation update for `F` +- Use global TypeDoc configuration file +- Compile and build documentation simultaneously +- Remove dependency on typescript (TypeDoc will take care of this) +- Remove declaration types for test on build output +- Output `tsc` version on `npm test` + ## 1.4.2 - Update dependency versions diff --git a/datafit/examples/package.json b/datafit/examples/package.json index 4a53ab87..dabbf8cd 100644 --- a/datafit/examples/package.json +++ b/datafit/examples/package.json @@ -3,6 +3,6 @@ "clean": "rm -rf node_modules package-lock.json" }, "dependencies": { - "datafit": "file:datafit-1.4.2.tgz" + "datafit": "file:datafit-1.4.3.tgz" } } \ No newline at end of file diff --git a/datafit/package.json b/datafit/package.json index 36074f71..3dc65e69 100644 --- a/datafit/package.json +++ b/datafit/package.json @@ -1,6 +1,6 @@ { "name": "datafit", - "version": "1.4.2", + "version": "1.4.3", "description": "Simple curve-fitting algorithm", "homepage": "https://npm.nicfv.com/datafit", "bin": "", @@ -11,12 +11,11 @@ "types" ], "scripts": { - "build": "rm -rf dist types && tsc && node dist/test.js && rm dist/test.js", - "test": "tsc --noEmit", + "build": "rm -rf dist types docs && typedoc --options ../typedoc.json src && node dist/test.js && rm dist/test.js types/test.d.ts", + "test": "tsc -v && tsc --noEmit", "clean": "rm -rf node_modules package-lock.json dist types docs", - "docs": "rm -rf docs && typedoc --includeVersion --disableSources --hideGenerator src", "prepack": "npm run build", - "postpack": "rm -rf dist types" + "postpack": "npm run clean" }, "keywords": [ "math", @@ -51,11 +50,10 @@ "repository": "github:nicfv/npm", "license": "MIT", "dependencies": { - "smath": "1.7.0" + "smath": "1.8.1" }, "devDependencies": { "exray": "1.0.3", - "typedoc": "0.25.12", - "typescript": "5.4.4" + "typedoc": "0.25.13" } } \ No newline at end of file diff --git a/datafit/src/types.ts b/datafit/src/types.ts index f438f95d..b2fa2a39 100644 --- a/datafit/src/types.ts +++ b/datafit/src/types.ts @@ -11,7 +11,7 @@ export type VariableType = number | Array; * return a2 * x ** 2 + a1 * x + a0; * } * ``` - * Multivariable function Typescript, general plane equation: + * Multivariable function in Typescript, general plane equation: * ```ts * function f([x, y]: number[], cx: number, cy: number, cz: number): number { * return cx * x + cy * y + cz; diff --git a/dimensional/CHANGELOG.md b/dimensional/CHANGELOG.md index 13069dd6..da4eda53 100644 --- a/dimensional/CHANGELOG.md +++ b/dimensional/CHANGELOG.md @@ -1,5 +1,14 @@ # Changelog +## 0.1.1 + +- Use global TypeDoc configuration file +- Compile and build documentation simultaneously +- Remove dependency on typescript (TypeDoc will take care of this) +- Remove declaration types for test on build output +- Output `tsc` version on `npm test` +- For now, export `lib` + ## 0.1.0 - Install relevant dependencies diff --git a/dimensional/examples/package.json b/dimensional/examples/package.json index 2bb0039c..70dd2d85 100644 --- a/dimensional/examples/package.json +++ b/dimensional/examples/package.json @@ -3,6 +3,6 @@ "clean": "rm -rf node_modules package-lock.json" }, "dependencies": { - "dimensional": "file:dimensional-0.1.0.tgz" + "dimensional": "file:dimensional-0.1.1.tgz" } } \ No newline at end of file diff --git a/dimensional/package.json b/dimensional/package.json index c83bdc30..9dd0bf52 100644 --- a/dimensional/package.json +++ b/dimensional/package.json @@ -1,6 +1,6 @@ { "name": "dimensional", - "version": "0.1.0", + "version": "0.1.1", "description": "Dimensional analysis and unit conversions", "homepage": "https://npm.nicfv.com/dimensional", "bin": "", @@ -11,12 +11,11 @@ "types" ], "scripts": { - "build": "rm -rf dist types && tsc && node dist/test.js && rm dist/test.js", - "test": "tsc --noEmit", + "build": "rm -rf dist types docs && typedoc --options ../typedoc.json src && node dist/test.js && rm dist/test.js types/test.d.ts", + "test": "tsc -v && tsc --noEmit", "clean": "rm -rf node_modules package-lock.json dist types docs", - "docs": "rm -rf docs && typedoc --includeVersion --disableSources --hideGenerator --excludePrivate --excludeProtected src", "prepack": "npm run build", - "postpack": "rm -rf dist types" + "postpack": "npm run clean" }, "keywords": [], "author": { @@ -35,7 +34,6 @@ }, "devDependencies": { "exray": "1.0.3", - "typedoc": "0.25.13", - "typescript": "5.4.5" + "typedoc": "0.25.13" } } \ No newline at end of file diff --git a/dimensional/src/index.ts b/dimensional/src/index.ts index 25ae1e83..77de906e 100644 --- a/dimensional/src/index.ts +++ b/dimensional/src/index.ts @@ -5,4 +5,5 @@ * Exports the public-facing API for `dimensional` */ export * from './dimension'; -export * from './unit'; \ No newline at end of file +export * from './unit'; +export * from './lib'; \ No newline at end of file diff --git a/exray/CHANGELOG.md b/exray/CHANGELOG.md index 49e6cdec..24df2659 100644 --- a/exray/CHANGELOG.md +++ b/exray/CHANGELOG.md @@ -1,5 +1,14 @@ # Changelog +## 1.0.4 + +- Use global TypeDoc configuration file +- Compile and build documentation simultaneously +- Remove dependency on typescript (TypeDoc will take care of this) +- Remove declaration types for test on build output +- Minor output change for test #1 +- Output `tsc` version on `npm test` + ## 1.0.3 - Update typescript dependency version to 5.4.4 diff --git a/exray/examples/1-Assert-Boolean-Values.mjs b/exray/examples/1-Assert-Boolean-Values.mjs index a817834f..8d4821e3 100644 --- a/exray/examples/1-Assert-Boolean-Values.mjs +++ b/exray/examples/1-Assert-Boolean-Values.mjs @@ -12,4 +12,7 @@ function alwaysReturnsFalse() { return false; } // This test should pass -X.false(alwaysReturnsFalse()); \ No newline at end of file +X.false(alwaysReturnsFalse()); + +// Show that all tests passed. +console.log('All tests passed!'); \ No newline at end of file diff --git a/exray/examples/package.json b/exray/examples/package.json index 851c86ec..f86fcdb1 100644 --- a/exray/examples/package.json +++ b/exray/examples/package.json @@ -3,6 +3,6 @@ "clean": "rm -rf node_modules package-lock.json" }, "dependencies": { - "exray": "file:exray-1.0.3.tgz" + "exray": "file:exray-1.0.4.tgz" } } \ No newline at end of file diff --git a/exray/package.json b/exray/package.json index 73833dcf..da9d9bd5 100644 --- a/exray/package.json +++ b/exray/package.json @@ -1,6 +1,6 @@ { "name": "exray", - "version": "1.0.3", + "version": "1.0.4", "description": "Lightweight assertion testing framework", "homepage": "https://npm.nicfv.com/exray", "bin": "", @@ -11,12 +11,11 @@ "types" ], "scripts": { - "build": "rm -rf dist types && tsc && node dist/test.js && rm dist/test.js", - "test": "tsc --noEmit", + "build": "rm -rf dist types docs && typedoc --options ../typedoc.json src && node dist/test.js && rm dist/test.js types/test.d.ts", + "test": "tsc -v && tsc --noEmit", "clean": "rm -rf node_modules package-lock.json dist types docs", - "docs": "rm -rf docs && typedoc --includeVersion --disableSources --hideGenerator src", "prepack": "npm run build", - "postpack": "rm -rf dist types" + "postpack": "npm run clean" }, "keywords": [ "except", @@ -41,7 +40,6 @@ "repository": "github:nicfv/npm", "license": "MIT", "devDependencies": { - "typedoc": "0.25.12", - "typescript": "5.4.4" + "typedoc": "0.25.13" } } \ No newline at end of file diff --git a/smath/CHANGELOG.md b/smath/CHANGELOG.md index 4d6cd240..e23b0dfa 100644 --- a/smath/CHANGELOG.md +++ b/smath/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## 1.8.2 + +- Use global TypeDoc configuration file +- Compile and build documentation simultaneously +- Remove dependency on typescript (TypeDoc will take care of this) +- Remove declaration types for test on build output +- Output `tsc` version on `npm test` + ## 1.8.1 - Fix an extremely rare case in `rint()` where it could generate a value 1 below the minimum value, if the random number generated by `Math.random()` is *exactly* zero and the input range is negative. Realistically, this would never happen, the odds of this are about one in `2^53`, or one in 9 quadrillion. You would need to generate **one million** numbers every second consistently for 285 years for a chance to see this happen once. diff --git a/smath/examples/package.json b/smath/examples/package.json index 2d8d5d64..9eb8cfc7 100644 --- a/smath/examples/package.json +++ b/smath/examples/package.json @@ -3,6 +3,6 @@ "clean": "rm -rf node_modules package-lock.json" }, "dependencies": { - "smath": "file:smath-1.8.1.tgz" + "smath": "file:smath-1.8.2.tgz" } } \ No newline at end of file diff --git a/smath/package.json b/smath/package.json index 850257fd..4c4f1931 100644 --- a/smath/package.json +++ b/smath/package.json @@ -1,6 +1,6 @@ { "name": "smath", - "version": "1.8.1", + "version": "1.8.2", "description": "Small math function library", "homepage": "https://npm.nicfv.com/smath", "bin": "dist/bin.js", @@ -11,12 +11,11 @@ "types" ], "scripts": { - "build": "rm -rf dist types && tsc && node dist/test.js && rm dist/test.js", - "test": "tsc --noEmit", + "build": "rm -rf dist types docs && typedoc --options ../typedoc.json src && node dist/test.js && rm dist/test.js types/test.d.ts", + "test": "tsc -v && tsc --noEmit", "clean": "rm -rf node_modules package-lock.json dist types docs", - "docs": "rm -rf docs && typedoc --includeVersion --disableSources --hideGenerator --excludePrivate --excludeProtected src", "prepack": "npm run build", - "postpack": "rm -rf dist types" + "postpack": "npm run clean" }, "keywords": [ "small", @@ -59,7 +58,6 @@ "devDependencies": { "@types/node": "20.12.7", "exray": "1.0.3", - "typedoc": "0.25.13", - "typescript": "5.4.5" + "typedoc": "0.25.13" } } \ No newline at end of file diff --git a/typedoc.json b/typedoc.json new file mode 100644 index 00000000..3b4d5be6 --- /dev/null +++ b/typedoc.json @@ -0,0 +1,10 @@ +{ + "disableSources": true, + "emit": "both", + "excludeExternals": true, + "excludePrivate": true, + "excludeProtected": true, + "hideGenerator": true, + "includeVersion": true, + "treatValidationWarningsAsErrors": true, +} \ No newline at end of file diff --git a/viridis/CHANGELOG.md b/viridis/CHANGELOG.md index 4ee44d30..237d3fdb 100644 --- a/viridis/CHANGELOG.md +++ b/viridis/CHANGELOG.md @@ -1,5 +1,14 @@ # Changelog +## 1.1.2 + +- Update dependency versions +- Use global TypeDoc configuration file +- Compile and build documentation simultaneously +- Remove dependency on typescript (TypeDoc will take care of this) +- Remove declaration types for test on build output +- Output `tsc` version on `npm test` + ## 1.1.1 - Update dependency versions diff --git a/viridis/examples/package.json b/viridis/examples/package.json index d23fbf4a..e2e415e7 100644 --- a/viridis/examples/package.json +++ b/viridis/examples/package.json @@ -3,6 +3,6 @@ "clean": "rm -rf node_modules package-lock.json" }, "dependencies": { - "viridis": "file:viridis-1.1.1.tgz" + "viridis": "file:viridis-1.1.2.tgz" } } \ No newline at end of file diff --git a/viridis/package.json b/viridis/package.json index ab6ce9d1..b0a6e862 100644 --- a/viridis/package.json +++ b/viridis/package.json @@ -1,6 +1,6 @@ { "name": "viridis", - "version": "1.1.1", + "version": "1.1.2", "description": "Color gradients for data visualization", "homepage": "https://npm.nicfv.com/viridis", "bin": "", @@ -11,12 +11,11 @@ "types" ], "scripts": { - "build": "rm -rf dist types && tsc && node dist/test.js && rm dist/test.js", - "test": "tsc --noEmit", + "build": "rm -rf dist types docs && typedoc --options ../typedoc.json src && node dist/test.js && rm dist/test.js types/test.d.ts", + "test": "tsc -v && tsc --noEmit", "clean": "rm -rf node_modules package-lock.json dist types docs", - "docs": "rm -rf docs && typedoc --includeVersion --disableSources --hideGenerator src", "prepack": "npm run build", - "postpack": "rm -rf dist types" + "postpack": "npm run clean" }, "keywords": [ "color", @@ -43,11 +42,10 @@ "repository": "github:nicfv/npm", "license": "MIT", "dependencies": { - "smath": "1.6.1" + "smath": "1.8.1" }, "devDependencies": { - "exray": "1.0.2", - "typedoc": "0.25.12", - "typescript": "5.4.4" + "exray": "1.0.3", + "typedoc": "0.25.13" } } \ No newline at end of file