From 47f37b2c8177c10346a3380a24ca52fca5e2cd7b Mon Sep 17 00:00:00 2001 From: adueck Date: Sun, 9 Oct 2022 15:03:13 +0500 Subject: [PATCH] new format for publishing --- README.md | 11 +++++++++-- package-lock.json | 4 ++-- package.json | 5 ++++- src/components/README.md | 3 +++ src/components/package.json | 7 ++++--- src/lib/README.md | 3 +++ src/lib/package.json | 5 +++-- 7 files changed, 28 insertions(+), 10 deletions(-) create mode 100644 src/components/README.md create mode 100644 src/lib/README.md diff --git a/README.md b/README.md index 9b6bb4d..4a38779 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,13 @@ A pashto inflection and verb conjugation engine, as well as functions and compon Also includes the [Pashto Verb Explorer](https://verbs.lingdocs.com) website. +This library is **published as two libraries**: + +- @lingdocs/inflect + - The core inflection engine with grammatical information and tools for processing LingDocs dictionary entries and Pashto text. +- @lingdocs/ps-react + - @lingdocs/inflect plus react components for displaying Pashto text, phrase engine UI etc. + ## Development The Pashto Verb Explorer website can be used to view and play with the verb conjugations and various components. @@ -31,9 +38,9 @@ yarn build-website This outputs a site at `/build` -### Library +### Libraries -To build the `pashto-inflector` library ready for publishing to NPM: +To build the `@lingdocs/inflet` and `@lingdocs/ps-react` libraries ready for publishing to NPM: ``` yarn build-library diff --git a/package-lock.json b/package-lock.json index 3e521b4..98d5857 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "pashto-inflector", - "version": "4.9.18", + "version": "5.0.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "pashto-inflector", - "version": "4.9.18", + "version": "5.0.0", "hasInstallScript": true, "license": "MIT", "dependencies": { diff --git a/package.json b/package.json index 264f5f5..3978af7 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "pashto-inflector", - "version": "4.9.18", + "version": "5.0.0", "author": "lingdocs.com", "description": "A Pashto inflection and verb conjugation engine, inculding React components for displaying Pashto text, inflections, and conjugations", "homepage": "https://verbs.lingdocs.com", @@ -31,6 +31,9 @@ "web-vitals": "^1.0.1" }, "scripts": { + "patch": "npm version patch --no-git-tag-version && cd src/lib && npm version patch --no-git-tag-version && cd ../components && npm version patch --no-git-tag-version", + "minor": "npm version minor --no-git-tag-version && cd src/lib && npm version minor --no-git-tag-version && cd ../components && npm version minor --no-git-tag-version", + "major": "npm version major --no-git-tag-version && cd src/lib && npm version major --no-git-tag-version && cd ../components && npm version major --no-git-tag-version", "preinstall": "echo '*** Be sure to use yarn install-r not yarn install ***!'", "start": "react-scripts start", "build": "react-scripts build", diff --git a/src/components/README.md b/src/components/README.md new file mode 100644 index 0000000..7c7b6ea --- /dev/null +++ b/src/components/README.md @@ -0,0 +1,3 @@ +# @lingdocs/inflect + +The core inflection engine with grammatical information and tools for processing LingDocs dictionary entries and Pashto text. diff --git a/src/components/package.json b/src/components/package.json index 0b2fba6..4eea0ba 100644 --- a/src/components/package.json +++ b/src/components/package.json @@ -1,10 +1,10 @@ { "name": "@lingdocs/ps-react", - "version": "0.0.7", + "version": "5.0.0", "description": "Pashto inflector library module with React components", "main": "dist/components/library.js", "module": "dist/components/library.js", - "types": "dist/components/library.d.ts", + "types": "dist/components/library.d.ts", "repository": { "type": "git", "url": "https://github.com/lingdocs/pashto-inflector.git" @@ -13,7 +13,8 @@ "registry": "https://npm.lingdocs.com" }, "files": [ - "dist" + "dist", + "README.md" ], "scripts": { "build": "echo \"build from repo root\"" diff --git a/src/lib/README.md b/src/lib/README.md new file mode 100644 index 0000000..eaa21a1 --- /dev/null +++ b/src/lib/README.md @@ -0,0 +1,3 @@ +# @lingdocs/ps-react + +The core inflection engine with grammatical information and tools for processing LingDocs dictionary entries and Pashto text (@lingdocs/inflect) plus react components for displaying Pashto text, and phrase engine UI etc. \ No newline at end of file diff --git a/src/lib/package.json b/src/lib/package.json index 270c508..45ebdf7 100644 --- a/src/lib/package.json +++ b/src/lib/package.json @@ -1,6 +1,6 @@ { "name": "@lingdocs/inflect", - "version": "0.0.7", + "version": "5.0.0", "description": "Pashto inflector library", "main": "dist/index.js", "types": "dist/lib/library.d.ts", @@ -12,7 +12,8 @@ "registry": "https://npm.lingdocs.com" }, "files": [ - "dist" + "dist", + "README.md" ], "scripts": { "build": "echo \"build from repo root\""