diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 61b074e..fd014fd 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -28,4 +28,4 @@ jobs: node-version: ${{ matrix.node-version }} - run: pnpm install - - run: pnpm run test + - run: pnpm run test:coverage diff --git a/README.md b/README.md index 5d491fa..371a0db 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,22 @@ # @codevachon/classnames -A Library Used for managing ClassNames in Javascript +A Library Used for managing ClassNames in Javascript. + +Checkout the [TypeDoc](https://codevachon.github.io/classnames/). + +## Install + +```sh +pnpm add @codevachon/classnames +``` + +```sh +yarn add @codevachon/classnames +``` + +```sh +npm install @codevachon/classnames +``` ## Usage diff --git a/config/tsconfig.base.json b/config/tsconfig.base.json index 1d98cb6..fe937ab 100644 --- a/config/tsconfig.base.json +++ b/config/tsconfig.base.json @@ -10,5 +10,5 @@ "declarationMap": true, "allowSyntheticDefaultImports": true }, - "files": ["../src/index.ts"] + "files": ["../src/ClassNames.ts"] } diff --git a/package.json b/package.json index 4b8a96e..1964984 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@codevachon/classnames", - "version": "1.0.0", + "version": "1.0.1", "license": "MIT", "author": { "email": "code@christophervachon.com", @@ -9,12 +9,13 @@ }, "scripts": { "test": "jest", + "test:coverage": "jest --coverage", "clean": "rm -rf ./lib ./docs", "build": "npm run clean && npm run build:esm && npm run build:cjs", - "build:esm": "tsc -p ./config/tsconfig.esm.json && mv lib/esm/index.js lib/esm/index.mjs", + "build:esm": "tsc -p ./config/tsconfig.esm.json && mv lib/esm/ClassNames.js lib/esm/ClassNames.mjs", "build:cjs": "tsc -p ./config/tsconfig.cjs.json", "prepack": "npm run build", - "build:docs": "rm -fr docs && typedoc src/index.ts", + "build:docs": "rm -fr docs && typedoc src/ClassNames.ts", "serve:docs": "http-server ./docs", "preinstall": "npx only-allow pnpm" }, @@ -26,20 +27,20 @@ "type": "git", "url": "git@github.com:CodeVachon/classnames.git" }, - "types": "./lib/cjs/types/index.d.ts", - "main": "./lib/cjs/index.js", + "types": "./lib/cjs/types/ClassNames.d.ts", + "main": "./lib/cjs/ClassNames.js", "files": [ "lib/**/*" ], "exports": { ".": { "import": { - "types": "./lib/esm/types/index.d.ts", - "default": "./lib/esm/index.mjs" + "types": "./lib/esm/types/ClassNames.d.ts", + "default": "./lib/esm/ClassNames.mjs" }, "require": { - "types": "./lib/cjs/types/index.d.ts", - "default": "./lib/cjs/index.js" + "types": "./lib/cjs/types/ClassNames.d.ts", + "default": "./lib/cjs/ClassNames.js" } } }, @@ -47,7 +48,7 @@ "access": "public" }, "engines": { - "node": ">=12" + "node": ">=16" }, "keywords": [ "className" diff --git a/src/index.ts b/src/index.ts deleted file mode 100644 index 7f505b3..0000000 --- a/src/index.ts +++ /dev/null @@ -1 +0,0 @@ -export * from "./ClassNames";