chore: prepare v1.0.0

twhiston · Dec 27, 2023 · 7eaecfa · 7eaecfa
1 parent 95f2fb1
commit 7eaecfa
Show file tree

Hide file tree

Showing 105 changed files with 41,855 additions and 7,784 deletions.
diff --git a/.github/workflows/prcommitname.yml b/.github/workflows/prcommitname.yml
@@ -0,0 +1,32 @@
+name: PR Conventional Commit Validation
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, edited]
+
+jobs:
+  validate-pr-title:
+    runs-on: ubuntu-latest
+    steps:
+      # check PR title for conventional commit format
+      - name: PR Conventional Commit Validation
+        uses:  ytanikin/PRConventionalCommits@1.1.0
+        with:
+          task_types: '["build", "chore", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "style", "test", "release"]'
+          add_label: 'false'
+      # we need to install our node modules to get access to commitlint for the next step
+      - name: 'Checkout repository'
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: 'Install Node Modules'
+        working-directory: ./javascript
+        run: npm ci
+      # lint the commit message to ensure it can be included in the changelog later
+      - name: Validate current commit (last commit) with commitlint
+        if: github.event_name == 'push'
+        run: NODE_PATH="${{ github.workspace }}/javascript/node_modules" ./javascript/node_modules/.bin/commitlint --from HEAD~1 --to HEAD --verbose
+      # all commits in a PR should conform, in the occasion that we do not squash it
+      - name: Validate PR commits with commitlint
+        if: github.event_name == 'pull_request'
+        run:  NODE_PATH="${{ github.workspace }}/javascript/node_modules" ./javascript/node_modules/.bin/commitlint --from ${{ github.event.pull_request.head.sha }}~${{ github.event.pull_request.commits }} --to ${{ github.event.pull_request.head.sha }} --verbose
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -0,0 +1,96 @@
+# Name of our workflow
+name: 'Test and release'
+
+# Events that will trigger our workflow
+on: [ 'pull_request', 'push' ]
+
+# List of custom jobs
+jobs:
+  # Job is called "test"
+  test:
+    # Using a "label" to assign job to a specific hosted runner
+    runs-on: ubuntu-latest
+    steps:
+      # Checks-out our repository under "$GITHUB_WORKSPACE", so our job can access it
+      - name: 'Checkout repository'
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+        # Test and output coverage report
+      - name: 'Run tests'
+        working-directory: ./javascript
+        run: npm ci && npx nyc ava && npx nyc report --reporter cobertura --reporter json-summary
+
+      # lint the commit message to ensure it can be included in the changelog later
+      - name: Validate current commit (last commit) with commitlint
+        if: github.event_name == 'push'
+        run: NODE_PATH="${{ github.workspace }}/javascript/node_modules" ./javascript/node_modules/.bin/commitlint --from HEAD~1 --to HEAD --verbose
+      # all commits in a PR should conform, in the occasion that we do not squash it
+      - name: Validate PR commits with commitlint
+        if: github.event_name == 'pull_request'
+        run:  NODE_PATH="${{ github.workspace }}/javascript/node_modules" ./javascript/node_modules/.bin/commitlint --from ${{ github.event.pull_request.head.sha }}~${{ github.event.pull_request.commits }} --to ${{ github.event.pull_request.head.sha }} --verbose
+
+      # Get the coverage report and add a coverage comment
+      - name: Code Coverage Report
+        uses: irongut/CodeCoverageSummary@v1.3.0
+        with:
+          filename: ./javascript/coverage/cobertura-coverage.xml
+          badge: true
+          fail_below_min: true
+          format: markdown
+          hide_branch_rate: false
+          hide_complexity: false
+          indicators: true
+          output: both
+          thresholds: '60 80'
+      - name: Add Coverage PR Comment
+        uses: marocchino/sticky-pull-request-comment@v2
+        if: github.event_name == 'pull_request'
+        with:
+          recreate: true
+          path: code-coverage-results.md
+      - name: Create Coverage Badges
+        uses: jaywcjlove/coverage-badges-cli@main
+        with:
+          style: flat
+          source: ./javascript/coverage/coverage-summary.json
+          output: ./javascript/coverage/badges.svg
+
+      # Build a release from this version and archive it for testing
+      - name: 'build release'
+        working-directory: ./javascript
+        run: ./build-release.sh
+
+      - name: Save short sha to env
+        run: |
+          calculatedSha=$(git rev-parse --short ${{ github.sha }})
+          echo "short_sha=$calculatedSha" >> "$GITHUB_ENV"
+
+      - name: test artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: GLRepl-${{ env.short_sha }}
+          path: .dist/GLRepl.zip
+
+  # release:
+  #   needs: ["test"]
+  #   runs-on: ubuntu-latest
+  #   if:
+  #       contains('refs/heads/main', github.ref)
+  #   steps:
+  #     - name: 'Checkout repository'
+  #       uses: actions/checkout@v3
+  #       with:
+  #         fetch-depth: 0
+
+  #     - name: git config
+  #       run: |
+  #         git config user.name "${GITHUB_ACTOR}"
+  #         git config user.email "${GITHUB_ACTOR}@users.noreply.github.com"
+  #     # Part of the release script is to compile the code, so we don't need to redo this
+  #     - name: 'release'
+  #       working-directory: ./javascript
+  #       run: npm ci && npx release-it --ci
+  #       env:
+  #         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,9 @@
+.nyc_output
+corpus
+javascript/coverage
+javascript/node_modules
+reference
+examples/livecode-max/node_modules
+javascript/dist
+docs
+.dist
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -0,0 +1,23 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Debug AVA test file",
+            "runtimeExecutable": "/Users/twhiston/.nvm/versions/node/v18.16.0/bin/node",
+            "program": "${workspaceFolder}/javascript/node_modules/ava/entrypoints/cli.mjs",
+            "args": [
+                "${file}"
+            ],
+            "cwd": "${fileDirname}",
+            "outputCapture": "std",
+            "skipFiles": [
+                "<node_internals>/**/*.js"
+            ]
+        }
+    ]
+}
diff --git a/.vscode/node_modules/.cache/ava/failing-tests.json b/.vscode/node_modules/.cache/ava/failing-tests.json
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,20 @@
+{
+    "markiscodecoverage.searchCriteria": "javascript/coverage/lcov.info",
+    "editor.formatOnSave": true,
+    "coverage-gutters.coverageBaseDir": "./javascript/coverage",
+    "coverage-gutters.coverageFileNames": [
+        "lcov.info",
+        "cov.xml",
+        "coverage.xml",
+        "jacoco.xml",
+        "coverage.cobertura.xml"
+    ],
+    "[handlebars]": {
+        "editor.formatOnSave": false
+    },
+    "conventionalCommits.scopes": [
+        "formatters",
+        "extras-patch"
+    ],
+    "GitHooks.hooksDirectory": "/Users/twhiston/Documents/Max 8/Packages/GLRepl/.git/hooks",
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,86 @@
+# tw.gl.repl changelog
+
+## [1.0.0-beta.9](https://github.com/twhiston/tw.gl.repl/compare/1.0.0-beta.8...1.0.0-beta.9) (2023-11-11)
+
+
+### Features
+
+* add ability to hide text in the repl with key command and max message ([#16](https://github.com/twhiston/tw.gl.repl/issues/16)) ([fc6b2ee](https://github.com/twhiston/tw.gl.repl/commit/fc6b2ee20fbe739b258586eea88b93fc34676946))
+
+
+### Bug Fixes
+
+* fixes via c74 ([0b3ec8e](https://github.com/twhiston/tw.gl.repl/commit/0b3ec8ec88142d35bb89b3d5fc61d4f96b370476))
+
+## [1.0.0-beta.8](https://github.com/twhiston/tw.gl.repl/compare/1.0.0-beta.7...1.0.0-beta.8) (2023-10-21)
+
+
+### Bug Fixes
+
+* c74 feedback adjustments ([#15](https://github.com/twhiston/tw.gl.repl/issues/15)) ([51dfec4](https://github.com/twhiston/tw.gl.repl/commit/51dfec48305f53a137a05a3154b0d4796fbc246e))
+
+## [1.0.0-beta.7](https://github.com/twhiston/tw.gl.repl/compare/1.0.0-beta.6...1.0.0-beta.7) (2023-09-09)
+
+## [1.0.0-beta.6](https://github.com/twhiston/tw.gl.repl/compare/1.0.0-beta.5...1.0.0-beta.6) (2023-09-07)
+
+
+### Bug Fixes
+
+* fix polarity of ignore_keys option and shortcode, add to help file ([#14](https://github.com/twhiston/tw.gl.repl/issues/14)) ([3571ba9](https://github.com/twhiston/tw.gl.repl/commit/3571ba9423005d6da5b9557420b090a3858c9baa))
+
+## [1.0.0-beta.5](https://github.com/twhiston/tw.gl.repl/compare/1.0.0-beta.4...1.0.0-beta.5) (2023-09-06)
+
+
+### Features
+
+* add package-info.json ([#13](https://github.com/twhiston/tw.gl.repl/issues/13)) ([41ec4de](https://github.com/twhiston/tw.gl.repl/commit/41ec4deccadf0f5fc32c6c1a5ba10a419d522ae7))
+
+## [1.0.0-beta.4](https://github.com/twhiston/tw.gl.repl/compare/1.0.0-beta.3...1.0.0-beta.4) (2023-09-04)
+
+### Features
+
+* **formatters:** add formatter to remove comment lines from output and activate by default ([#9](https://github.com/twhiston/tw.gl.repl/issues/9)) ([8338b12](https://github.com/twhiston/tw.gl.repl/commit/8338b12fe0c3335e3045c633e71302c05becab14))
+
+* improved help ([#11](https://github.com/twhiston/tw.gl.repl/issues/11)) ([db6a17d](https://github.com/twhiston/tw.gl.repl/commit/db6a17d11c9cde270b9da30e6c989840995dc364))
+
+* feat: expose jumpLine and jumpWord functions to router
+
+### Bug Fixes
+
+* full working windows config as default ([#10](https://github.com/twhiston/tw.gl.repl/issues/10)) ([265c8bb](https://github.com/twhiston/tw.gl.repl/commit/265c8bbcaf461d8cb1cf41f97ae2183e1f237f13))
+
+* fix: fixes issue with scaling not being properly applied on text set commands
+
+* fix: fix gotoIndex bug due to variable overloading
+
+* fix: fix jump word bindings to key which appears on default mac keyboard
+
+* refactor: change package name to GLRepl
+
+* fix: fix keypress processor destruction on config load to ensure preattached functions work
+
+* ci: change artifact path to new package name
+
+* ci: remove cruft from release
+
+* refactor: refactor glrepl variable names and associated documentation
+
+* fix: fix bug with cursor line indices going to -1
+
+* refactor: remove lines function in favor of length and add minimum index function
+
+* fix: fix issue with running the last line of the buffer in ephemeral mode
+
+* refactor(extras-patch): refactor example patch names and fix issue with livecode example when patcher deleted
+
+* docs: update docs and build out overview patch
+
+## [1.0.0-beta.3](https://github.com/twhiston/th.gl.texteditor/compare/1.0.0-beta.2...1.0.0-beta.3) (2023-05-16)
+
+## [1.0.0-beta.2](https://github.com/twhiston/th.gl.texteditor/compare/1.0.0-beta.1...1.0.0-beta.2) (2023-05-16)
+
+## [1.0.0-beta.1](https://github.com/twhiston/th.gl.texteditor/compare/1.0.0-beta.0...1.0.0-beta.1) (2023-05-11)
+
+### Features
+
+* add supress_output function to stop message output, use with output_matrix for mercury drop-in ([5c50ec3](https://github.com/twhiston/th.gl.texteditor/commit/5c50ec364c58185c036ba26a2992cac758163003))