Merge pull request #1026 from rvsia/yarnTestPackage

rvsia · web-flow · commit d455cf311d66 · 2021-04-07T14:39:59.000+02:00
Add yarn test shortcut for each package
diff --git a/README.md b/README.md
@@ -275,7 +275,7 @@ All packages are linked together by default, so if you run a `yarn build` in a p
 
 #### Tests
 
-Tests needed to be run from the core folder.
+Tests can be ran from the core folder or from specific packages.
 
 ```console
 yarn test
diff --git a/packages/ant-component-mapper/README.md b/packages/ant-component-mapper/README.md
@@ -142,7 +142,7 @@ All packages are linked together by default, so if you run a `yarn build` in a p
 
 #### Tests
 
-Tests needed to be run from the core folder.
+Tests can be ran from the core folder or from specific packages.
 
 ```console
 yarn test
diff --git a/packages/ant-component-mapper/package.json b/packages/ant-component-mapper/package.json
@@ -15,7 +15,8 @@
     "build:packages": "node ../../scripts/generate-packages.js",
     "vendor": "webpack --env vendor --config ./config/webpack.config.js",
     "release": "semantic-release",
-    "build:css": "node ../../scripts/copy-css.js"
+    "build:css": "node ../../scripts/copy-css.js",
+    "test": "yarn --cwd ../.. test packages/ant-component-mapper"
   },
   "repository": "git@github.com:data-driven-forms/react-forms.git",
   "devDependencies": {
diff --git a/packages/blueprint-component-mapper/README.md b/packages/blueprint-component-mapper/README.md
@@ -139,7 +139,7 @@ All packages are linked together by default, so if you run a `yarn build` in a p
 
 #### Tests
 
-Tests needed to be run from the core folder.
+Tests can be ran from the core folder or from specific packages.
 
 ```console
 yarn test
diff --git a/packages/blueprint-component-mapper/package.json b/packages/blueprint-component-mapper/package.json
@@ -13,7 +13,8 @@
     "build:esm": "BABEL_ENV=esm babel src --out-dir ./esm --ignore \"src/tests/*\"",
     "build:typings": "node ../../scripts/generate-typings.js",
     "build:packages": "node ../../scripts/generate-packages.js",
-    "release": "semantic-release"
+    "release": "semantic-release",
+    "test": "yarn --cwd ../.. test packages/blueprint-component-mapper"
   },
   "repository": "git@github.com:data-driven-forms/react-forms.git",
   "keywords": [
diff --git a/packages/carbon-component-mapper/README.md b/packages/carbon-component-mapper/README.md
@@ -138,7 +138,7 @@ All packages are linked together by default, so if you run a `yarn build` in a p
 
 #### Tests
 
-Tests needed to be run from the core folder.
+Tests can be ran from the core folder or from specific packages.
 
 ```console
 yarn test
diff --git a/packages/carbon-component-mapper/package.json b/packages/carbon-component-mapper/package.json
@@ -13,7 +13,8 @@
     "build:esm": "BABEL_ENV=esm babel src --out-dir ./esm --ignore \"src/tests/*\"",
     "build:typings": "node ../../scripts/generate-typings.js",
     "build:packages": "node ../../scripts/generate-packages.js",
-    "release": "semantic-release"
+    "release": "semantic-release",
+    "test": "yarn --cwd ../.. test packages/carbon-component-mapper"
   },
   "repository": "git@github.com:data-driven-forms/react-forms.git",
   "keywords": [
diff --git a/packages/common/package.json b/packages/common/package.json
@@ -10,7 +10,8 @@
     "build:cjs": "BABEL_ENV=cjs babel src --out-dir ./",
     "build:esm": "BABEL_ENV=esm babel src --out-dir ./esm",
     "build:typings": "node ../../scripts/generate-typings.js",
-    "build:packages": "node ../../scripts/generate-packages.js"
+    "build:packages": "node ../../scripts/generate-packages.js",
+    "test": "yarn --cwd ../.. test packages/common"
   },
   "repository": "git@github.com:data-driven-forms/react-forms.git",
   "devDependencies": {
diff --git a/packages/mui-component-mapper/README.md b/packages/mui-component-mapper/README.md
@@ -142,7 +142,7 @@ All packages are linked together by default, so if you run a `yarn build` in a p
 
 #### Tests
 
-Tests needed to be run from the core folder.
+Tests can be ran from the core folder or from specific packages.
 
 ```console
 yarn test
diff --git a/packages/mui-component-mapper/package.json b/packages/mui-component-mapper/package.json
@@ -14,7 +14,8 @@
     "build:typings": "node ../../scripts/generate-typings.js",
     "build:packages": "node ../../scripts/generate-packages.js",
     "vendor": "webpack --env vendor --config ./config/webpack.config.js",
-    "release": "semantic-release"
+    "release": "semantic-release",
+    "test": "yarn --cwd ../.. test packages/mui-component-mapper"
   },
   "repository": "git@github.com:data-driven-forms/react-forms.git",
   "devDependencies": {
diff --git a/packages/parsers/README.md b/packages/parsers/README.md
@@ -94,11 +94,15 @@ yarn build
 
 3. Test a package
 
-You can test parsers using tests. Tests needed to be run from the core folder.
+You can test parsers using tests. Tests can be ran from core folder or from specific package.
 
 ```console
+yarn test --watchAll packages/pf4-component-mapper
+
+# or
+
 cd packages/pf4-component-mapper
-yarn test --watchAll packages/parsers
+yarn test
 ```
 
 4. How to clean?
diff --git a/packages/parsers/package.json b/packages/parsers/package.json
@@ -7,7 +7,8 @@
   "private": true,
   "license": "Apache-2.0",
   "scripts": {
-    "build": "rollup -c ./rollup.config.js"
+    "build": "rollup -c ./rollup.config.js",
+    "test": "yarn --cwd ../.. test packages/parsers"
   },
   "repository": "git@github.com:data-driven-forms/react-forms.git",
   "keywords": [
diff --git a/packages/pf4-component-mapper/README.md b/packages/pf4-component-mapper/README.md
@@ -157,7 +157,7 @@ All packages are linked together by default, so if you run a `yarn build` in a p
 
 #### Tests
 
-Tests needed to be run from the core folder.
+Tests can be ran from the core folder or from specific packages.
 
 ```console
 yarn test
diff --git a/packages/pf4-component-mapper/package.json b/packages/pf4-component-mapper/package.json
@@ -14,7 +14,8 @@
     "build:typings": "node ../../scripts/generate-typings.js",
     "build:packages": "node ../../scripts/generate-packages.js",
     "build:css": "node ../../scripts/copy-css.js",
-    "release": "semantic-release"
+    "release": "semantic-release",
+    "test": "yarn --cwd ../.. test packages/pf4-component-mapper"
   },
   "repository": "git@github.com:data-driven-forms/react-forms.git",
   "keywords": [
diff --git a/packages/react-form-renderer/README.md b/packages/react-form-renderer/README.md
@@ -276,7 +276,7 @@ All packages are linked together by default, so if you run a `yarn build` in a p
 
 #### Tests
 
-Tests needed to be run from the core folder.
+Tests can be ran from the core folder or from specific packages.
 
 ```console
 yarn test
diff --git a/packages/react-form-renderer/package.json b/packages/react-form-renderer/package.json
@@ -12,7 +12,8 @@
     "build:esm": "BABEL_ENV=esm babel src --out-dir ./esm --ignore \"src/tests/*\"",
     "build:typings": "node ../../scripts/generate-typings.js",
     "build:packages": "node ../../scripts/generate-packages.js",
-    "release": "semantic-release"
+    "release": "semantic-release",
+    "test": "yarn --cwd ../.. test packages/react-form-renderer"
   },
   "repository": "git@github.com:data-driven-forms/react-forms.git",
   "keywords": [
diff --git a/packages/react-renderer-demo/src/pages/development-setup.md b/packages/react-renderer-demo/src/pages/development-setup.md
@@ -6,6 +6,25 @@ import DocPage from '@docs/doc-page';
 
 Data Driven Forms is a monorepo that uses [Lerna](https://github.com/lerna/lerna) and [yarn workspaces](https://classic.yarnpkg.com/blog/2017/08/02/introducing-workspaces/), so you can use all its commands as well.
 
+## Checklist before you send a PR
+
+Please follow following checklist if you are going to open a PR. It will help you make the PR finished.
+
+- [ ] `Yarn build` passes
+- [ ] `Yarn lint` passes
+- [ ] `Yarn test` passes
+- [ ] Test coverage for new code *(if applicable)*
+- [ ] Documentation update *(if applicable)*
+- [ ] **Correct commit message**
+   - format `fix|feat({scope}): {description}`
+   - i.e. `fix(pf3): wizard correctly handles next button`
+   - fix will release a new \_.\_.X version
+   - feat will release a new \_.X.\_ version (use when you introduce new features)
+     - we want to avoid any breaking changes, please contact us, if there is no way how to avoid them
+   - scope: package
+   - **if you update the documentation or tests, do not use this format**
+     - i.e. `Fix button on documenation example page`
+
 ## Install
 
 ```bash
@@ -48,12 +67,17 @@ yarn lerna clean # will delete all node_modules
 
 ## Tests
 
-Tests needed to be run from the core folder.
+You can test parsers using tests. Tests can be ran from core folder or from specific package.
 
-```bash
+```console
 yarn test
 
-yarn test packages/pf3-component-mapper
+yarn test --watchAll packages/pf4-component-mapper
+
+# or
+
+cd packages/pf4-component-mapper
+yarn test
 ```
 
 ## Commits
@@ -65,7 +89,7 @@ Format:
 ```
 [type]([package]): message
 
-fix(pf3): title accepts node
+fix(pf4): title accepts node
 ```
 
 Types:
diff --git a/packages/suir-component-mapper/README.md b/packages/suir-component-mapper/README.md
@@ -139,7 +139,7 @@ All packages are linked together by default, so if you run a `yarn build` in a p
 
 #### Tests
 
-Tests needed to be run from the core folder.
+Tests can be ran from the core folder or from specific packages.
 
 ```console
 yarn test
diff --git a/packages/suir-component-mapper/package.json b/packages/suir-component-mapper/package.json
@@ -13,7 +13,8 @@
     "build:esm": "BABEL_ENV=esm babel src --out-dir ./esm --ignore \"src/tests/*\"",
     "build:typings": "node ../../scripts/generate-typings.js",
     "build:packages": "node ../../scripts/generate-packages.js",
-    "release": "semantic-release"
+    "release": "semantic-release",
+    "test": "yarn --cwd ../.. test packages/suir-component-mapper"
   },
   "repository": "git@github.com:data-driven-forms/react-forms.git",
   "devDependencies": {
diff --git a/templates/component-mapper/README.md b/templates/component-mapper/README.md
@@ -137,7 +137,7 @@ All packages are linked together by default, so if you run a `yarn build` in a p
 
 #### Tests
 
-Tests needed to be run from the core folder.
+Tests can be ran from the core folder or from specific packages.
 
 ```console
 yarn test
