Psl 1511 mvp remove bundling from the package (#25)

* update build pipeline

* remove addon

* update readme

* ignore lib folder

* update github actions

* Build library and supporting storybook documentation

* update readme

* update api key in read me

* Build library and supporting storybook documentation

* update api autocomplete key

* update api key in sb code snippets

* add github workflows

* update guthub actions

* fix linting errors and update package-lock

* add codeql analyze and diffend env vars

* Build library and supporting storybook documentation

* Revert "Build library and supporting storybook documentation"

This reverts commit 73ff726.

* Build library and supporting storybook documentation

* fix jobs

Co-authored-by: GitHub Actions <[email protected]>

Author: mocca102

.diffend.yml

@@ -0,0 +1,3 @@
+project_id: '7d7bd830-030a-446c-9c08-3a0e3c738f42'
+shareable_id: 'ac0d321f-b01a-4ede-8e19-ee6fce1668cc'
+shareable_key: 'e932639a-bc20-4cba-a79b-cf4ff2da3b94'

.eslintrc.json

@@ -15,17 +15,12 @@
     "ecmaVersion": "latest",
     "project": "tsconfig.eslint.json"
   },
-  "plugins": [
-    "@typescript-eslint",
-    "prettier"
-  ],
+  "plugins": ["@typescript-eslint", "prettier"],
   "rules": {
     "prefer-const": "error",
     "@typescript-eslint/no-unused-vars": "off",
     "@typescript-eslint/no-unused-params": "off",
-    "prettier/prettier": [
-      "error"
-    ]
+    "prettier/prettier": ["error"]
   },
   "overrides": [
     {
@@ -36,9 +31,5 @@
       }
     }
   ],
-  "ignorePatterns": [
-    "*.config.js",
-    "lib/**/*.js",
-    "lib/*.d.ts"
-  ]
+  "ignorePatterns": ["*.config.js", "lib/**/*.js", "lib/**/*.d.ts", "docs/**/*.js"]
 }

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: 'CodeQL'
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [master]
+  schedule:
+    - cron: '34 5 * * 4'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: ['javascript']
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v1
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+          # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v1
+
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 https://git.io/JvXDl
+
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+      #    and modify them (or add more) to build your code if your project
+      #    uses a compiled language
+
+      #- run: |
+      #   make bootstrap
+      #   make release
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v1

.github/workflows/run-diffend.yml

@@ -0,0 +1,24 @@
+name: Run Diffend
+
+on:
+  push:
+    branches:
+      - '*'
+      - '!main'
+concurrency:
+  group: run-diffend-${{ github.head_ref }}
+  cancel-in-progress: true
+jobs:
+  diffend:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v2
+      - name: Set up node
+        uses: actions/setup-node@v2
+        with:
+          node-version: '16.13.0'
+      - name: Install Diffend (Mend)
+        run: npm install -g https://my.diffend.io/releases/npm/stable.tgz
+      - name: Install dependencies with Diffend
+        run: diffend npm install

.github/workflows/run-lint.yml

@@ -0,0 +1,23 @@
+name: Run lint
+on:
+  push:
+    branches:
+      - '*'
+      - '!main'
+concurrency:
+  group: run-lint-${{ github.head_ref }}
+  cancel-in-progress: true
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v2
+      - name: Set up node
+        uses: actions/setup-node@v2
+        with:
+          node-version: '16.13.0'
+      - name: Install dependencies
+        run: npm install
+      - name: Run lint
+        run: npm run lint

.github/workflows/spell-check.yml

@@ -0,0 +1,23 @@
+name: Spell check
+
+on:
+  push:
+    branches:
+      - '*'
+      - '!main'
+concurrency:
+  group: spell-check-${{ github.head_ref }}
+  cancel-in-progress: true
+jobs:
+  check:
+    name: Run spell check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v2
+      - name: Set up node
+        uses: actions/setup-node@v2
+        with:
+          node-version: '16.13.0'
+      - name: Spell check
+        run: npx cspell "**/*.{ts,tsx}"

.github/workflows/test-build.yml

@@ -5,21 +5,25 @@ on:
     branches:
       - '*'
       - '!main'
-
+concurrency:
+  group: run-tests-and-build-${{ github.head_ref }}
+  cancel-in-progress: true     
 jobs:
   test-storybook:
     timeout-minutes: 15
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - name: Check out code
+        uses: actions/checkout@v2
+      - name: Set up node
+        uses: actions/setup-node@v2
         with:
           node-version: '16.13.0'
       - name: Install dependencies
         run: npm ci
-      - name: Run All Storybook Tests
+      - name: Run Tests
         run: npm run test-storybook:ci
-  build:
+  test-build-scripts:
     runs-on: ubuntu-latest
     needs: test-storybook
     steps:
@@ -29,15 +33,7 @@ jobs:
           node-version: '16.13.0'
       - name: Install
         run: npm ci
-      - name: Build static storybook files for deploy to GitHub Pages
+      - name: test run build-storybook without error
         run: npm run build-storybook
-      - name: Generate library bundle ready for publishing
-        run: npm run bundle
-      - name: Commit changes
-        uses: EndBug/add-and-commit@v9
-        with:
-          author_name: GitHub Actions
-          author_email: [email protected]
-          message: 'Build library bundle and supporting storybook documentation'
-          add: '*'
-          commit: --no-verify
+      - name: test run compile without error
+        run: npm run compile

.github/workflows/version-and-release.yml

@@ -1,18 +1,37 @@
-name: Version and Release
+name: Version and Release and build storybook stories 
 
 on:
   push:
     branches:
       - main
-
 jobs:
+  build-storybook:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+        node-version: '16.13.0'
+      - name: Install
+        run: npm ci
+      - name: Build static storybook files for deploy to GitHub Pages
+        run: npm run build-storybook
+      - name: Commit changes
+        uses: EndBug/add-and-commit@v9
+        with:
+          author_name: GitHub Actions
+          author_email: [email protected]
+          message: 'Build library and supporting storybook documentation'
+          add: '*'
+          commit: --no-verify
   version-and-release:
     runs-on: ubuntu-latest
+    needs: build-storybook
     env:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     steps:
       - uses: rymndhng/release-on-push-action@master
         with:
           tag_prefix: "v"
           bump_version_scheme: norelease
-          release_name: "Release <RELEASE_TAG>"
+          release_name: "Release <RELEASE_TAG>"

.gitignore

@@ -89,7 +89,7 @@ out
 
 # Nuxt.js build / generate output
 .nuxt
-build
+lib
 
 # Gatsby files
 .cache/