Merge pull request #55 from bikecoders/add-scripts-workspace

chore: create scripts to generate workspaces

Author: dianjuar

.github/pull_request_template.md

@@ -1,11 +1,14 @@
 ## PR Checklist
+
 Please check if your PR fulfills the following requirements:
 
 - [ ] The commit message follows our guidelines: https://www.conventionalcommits.org/en/v1.0.0/
-- [ ] Tests for the changes have been added (for bug fixes / features)
-- [ ] Docs have been added / updated (for bug fixes / features)
+- [ ] Tests for the changes have been added (for bug fixes/features)
+- [ ] Docs have been added/updated (for bug fixes/features)
+- [ ] Both workspaces were tested Angular an Nx
 
 ## PR Type
+
 What kind of change does this PR introduce?
 
 <!-- Please check the one that applies to this PR using "x". -->
@@ -19,6 +22,7 @@ What kind of change does this PR introduce?
 - [ ] Other... Please describe:
 
 ## What is the current behavior?
+
 <!-- Please describe the current behavior that you are modifying or link to a relevant issue. -->
 
 Issue Number: N/A

docs/README_contributors.md

@@ -173,66 +173,28 @@ Questions 🤔? Drop your message on our [discord server](https://discord.gg/cPa
 
 ## Creating a Workspace to test your library
 
-You may want to test your changes in a real life scenario so
-there is some scripts that you can execute to create your workspace
+You may want to test your changes in a real life scenario.
+We have some scripts that you can execute to create your workspace
+and test your flaming changes 🔥
 
-### Nx
-
-```sh
-# Generate the Workspace
-npm init nx-workspace nx-workspace --preset empty --nx-cloud false
-cd nx-workspace
-
-# Install some deps
-npm install -D @nrwl/angular && \
-npm install -D @nrwl/nest && \
-npm install -D @nrwl/react && \
-npm install -D @nrwl/node
-
-# Generate all kind of libs
-npx nx generate @nrwl/angular:lib --name angular-lib --publishable --importPath angular-lib --style scss && \
-npx nx generate @nrwl/react:lib --name react-lib --publishable --importPath react-lib --style scss && \
-npx nx generate @nrwl/nest:lib --name nest-lib --publishable --importPath nest-lib && \
-npx nx generate @nrwl/node:lib --name node-lib --publishable --importPath node-lib
-
-# Save your changes to easily differ the changes made on the workspace.json
-git add . && git commit -m "chore: create boiler plate"
-
-# Link the project
-npm link ngx-deploy-npm
-
-# Add it to the workspace
-npx nx generate ngx-deploy-npm:ng-add
-
-# Test the build
-npx nx deploy react-lib --dry-run
-npx nx deploy angular-lib --dry-run
-npx nx deploy nest-lib --dry-run
-npx nx deploy node-lib --dry-run
-```
-
-### Angular
+> The creation of a new workspace will delete the previous one
 
-```sh
-# Generate the Workspace
-npx @angular/cli new --name angular-workspace --strict --routing --style scss
-cd angular-workspace
+### Nx
 
-# Generate lib
-npx ng generate library angular-lib
+`yarn run create-workspace:nx` will create a `nx-workspace` folder with a Nx workspace with
+4 publishable libraries to make your test on whatever lib you want
 
-# Save your changes to easily differ the changes made on the angular.json
-git add . && git commit -m "chore: create boiler plate"
+- react-lib
+- angular-lib
+- nest-lib
+- node-lib
 
-# Link the project
-npm link ngx-deploy-npm
+### Angular
 
-# Add it to the workspace
-npx ng add ngx-deploy-npm
+`yarn run create-workspace:angular` will create a `angular-workspace` folder with an Angular workspace with
+1 publishable libraries to make your test
 
-# Test the build
-npx ng deploy angular-lib --dry-run
-```
+- angular-lib
 
 ## Publish to NPM
 

src/package.json

@@ -17,7 +17,9 @@
     "test": "jest",
     "test:cov": "jest --coverage",
     "test:debug": "node --inspect-brk=0.0.0.0 node_modules/.bin/jest --runInBand",
-    "release": "standard-version --infile ../CHANGELOG.md"
+    "release": "standard-version --infile ../CHANGELOG.md",
+    "create-workspace:angular": "../tools/create-workspace-angular.sh",
+    "create-workspace:nx": "../tools/create-workspace-nx.sh"
   },
   "schematics": "./collection.json",
   "builders": "./builders.json",

tools/create-workspace-angular.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+cd ../..
+
+# Delete the previous workspace
+rm -Rif angular-workspace
+
+npx @angular/cli new --name angular-workspace --strict --routing --style scss
+cd angular-workspace
+
+# Generate lib
+npx ng generate library angular-lib
+
+# Save your changes to easily differ the changes made on the angular.json
+git add . && git commit -m "chore: create boiler plate"
+
+# Link the project
+yarn link ngx-deploy-npm
+
+# Add it to the workspace
+npx ng add ngx-deploy-npm
+
+# Test the build
+npx ng deploy angular-lib --dry-run

tools/create-workspace-nx.sh

@@ -0,0 +1,37 @@
+#!/bin/bash
+
+cd ../..
+
+# Delete the previous workspace
+rm -Rif nx-workspace
+
+# Generate the Workspace
+npm init nx-workspace nx-workspace --preset empty --nx-cloud false
+cd nx-workspace
+
+# Install some deps
+npm install -D @nrwl/angular \
+  @nrwl/nest \
+  @nrwl/react \
+  @nrwl/node
+
+# Generate all kind of libs
+npx nx generate @nrwl/angular:lib --name angular-lib --publishable --importPath angular-lib --style scss &&
+  npx nx generate @nrwl/react:lib --name react-lib --publishable --importPath react-lib --style scss &&
+  npx nx generate @nrwl/nest:lib --name nest-lib --publishable --importPath nest-lib &&
+  npx nx generate @nrwl/node:lib --name node-lib --publishable --importPath node-lib
+
+# Save your changes to easily differ the changes made on the workspace.json
+git add . && git commit -m "chore: create boiler plate"
+
+# Link the project
+yarn link ngx-deploy-npm
+
+# Add it to the workspace
+npx nx generate ngx-deploy-npm:ng-add
+
+# Test the build
+npx nx deploy react-lib --dry-run
+npx nx deploy angular-lib --dry-run
+npx nx deploy nest-lib --dry-run
+npx nx deploy node-lib --dry-run