update configs and code in README

electrovir · electrovir · commit eb53a57bbffc · 2021-10-24T17:28:38.000-06:00
diff --git a/.cspell-base.json b/.cspell-base.json
@@ -1,33 +1,53 @@
 {
-    "ignorePaths": [".DS_Store", ".git/", "dist/", "node_modules/", "package-lock.json"],
+    "ignorePaths": [
+        ".DS_Store",
+        ".git/",
+        "dist/",
+        "node_modules/",
+        "package-lock.json",
+        ".cspell-base.json",
+        ".cspell.json"
+    ],
     "version": "0.2",
     "words": [
         "accum",
+        "adipiscing",
+        "amet",
+        "andymckay",
         "argb",
         "autofix",
         "autofixable",
         "autofixing",
         "config's",
+        "consectetur",
         "cpsell",
         "derp",
         "derpy",
         "electrovir",
+        "entrypoints",
         "esbenp",
         "gitattributes",
         "globstar",
-        "globstar",
+        "locationchange",
+        "marvinpinto",
+        "nojekyll",
         "npmignore",
         "packagejson",
         "parens",
+        "pdfs",
         "prettierignore",
         "prettierrc",
+        "pushstate",
+        "replacestate",
         "repo's",
         "repos",
         "rgba",
         "stylelint",
         "stylelintrc",
         "subcommand",
         "thingie",
+        "threejs",
+        "transpiled",
         "transpiling",
         "typeof",
         "virmator's",
diff --git a/.github/workflows/virmator-prerelease.yml b/.github/workflows/virmator-prerelease.yml
@@ -0,0 +1,43 @@
+name: branch-prerelease
+
+on:
+    workflow_run:
+        workflows: ['tests']
+        branches: '**'
+        types:
+            - completed
+
+jobs:
+    package-release:
+        name: 'package release'
+        runs-on: 'ubuntu-latest'
+        if: ${{ github.event.workflow_run.conclusion == 'success' }}
+        steps:
+            - uses: actions/checkout@v1
+            - name: Use Node.js 14.x
+              uses: actions/setup-node@v1
+              with:
+                  node-version: 14.x
+            - name: run test
+              run: |
+                  npm ci
+                  npm run test:full
+            - name: pack and set vars
+              id: vars
+              run: |
+                  branchName="${GITHUB_REF#refs/*/}"
+                  echo ::set-output name=short_ref::"$branchName"
+
+                  originalTarName="$(npm pack)"
+                  packageName="$(npm -s run env echo '$npm_package_name')"
+                  timeStamp="$(date +%s)"
+                  newTarName="$packageName-$timeStamp.tgz"
+                  mv "$originalTarName" "$newTarName"
+                  echo ::set-output name=tar_name::"$newTarName"
+            - uses: 'marvinpinto/action-automatic-releases@latest'
+              with:
+                  repo_token: '${{ secrets.GITHUB_TOKEN }}'
+                  automatic_release_tag: 'prerelease-${{ steps.vars.outputs.short_ref }}'
+                  prerelease: true
+                  files: |
+                      ${{ steps.vars.outputs.tar_name }}
diff --git a/.github/workflows/virmator-tagged-release.yml b/.github/workflows/virmator-tagged-release.yml
@@ -0,0 +1,27 @@
+name: 'tagged-release'
+
+on:
+    push:
+        tags:
+            - 'v*'
+
+jobs:
+    tagged-release:
+        name: 'Tagged Release'
+        runs-on: 'ubuntu-latest'
+
+        steps:
+            - uses: actions/checkout@v1
+            - name: Use Node.js 14.x
+              uses: actions/setup-node@v1
+              with:
+                  node-version: 14.x
+            - name: run test
+              run: |
+                  npm ci
+                  npm run test:full
+
+            - uses: 'marvinpinto/action-automatic-releases@latest'
+              with:
+                  repo_token: '${{ secrets.GITHUB_TOKEN }}'
+                  prerelease: false
diff --git a/.npmignore b/.npmignore
@@ -1,23 +1,27 @@
 .cspell-base.json
 .cspell.json
 .gitattributes
-.github
+.github/
 .gitignore
 .prettierignore
 .prettierrc.js
-.vscode
+.vscode/
 *.test.d.ts
 *.test.js
-scripts
-src
-test-repos
+dist/test/
+scripts/
+snowpack.config.js
+snowpack.config.mjs
+src/
+static/
+test-repos/
 tsconfig-base.json
 tsconfig.json
-files
-dist/sanitizer
+
+files/
+dist/sanitizer/
 repo-paths*
 *.sh
-.git*
 dist/readme*
 dist/package-version*
 dist/bash*
diff --git a/README.md b/README.md
@@ -24,9 +24,9 @@ Currently tested on Node.js versions 12.x and 14.x in combination with the lates
 
 The high level most useful api function is the asynchronous [`parsePdfs`](https://github.com/electrovir/statement-parser/tree/master/src/parser/parse-api.ts) function. Simply pass in an array that has details for each PDF file you wish to parse. Note that there is no synchronous alternative.
 
-<!-- api-simple-parse.example.ts -->
+<!-- example-link: src/readme-examples/api-simple-parse.example.ts -->
 
-```typescript
+```TypeScript
 import {parsePdfs, ParserType} from 'statement-parser';
 
 parsePdfs([
@@ -41,9 +41,9 @@ parsePdfs([
 
 `parsePdfs` accepts an array of [`StatementPdf`](https://github.com/electrovir/statement-parser/tree/master/src/parser/parse-api.ts) objects. Thus, each element in the array should look like the following:
 
-<!-- api-simple-parse-inputs.example.ts -->
+<!-- example-link: src/readme-examples/api-simple-parse-inputs.example.ts -->
 
-```typescript
+```TypeScript
 import {ParserType, StatementPdf} from 'statement-parser';
 
 const myPdfToParse: StatementPdf = {
@@ -76,9 +76,9 @@ Currently built parsers are the following:
 
 Simply import `ParserType` to use these keys, as shown below and in the other [Examples](#examples) in this README:
 
-<!-- parser-type.example.ts -->
+<!-- example-link: src/readme-examples/parser-type.example.ts -->
 
-```typescript
+```TypeScript
 import {ParserType} from 'statement-parser';
 
 // possible ParserType keys
@@ -93,10 +93,10 @@ ParserType.Paypal;
 
 -   There are extra parser inputs:
 
-    <!-- all-options.example.ts -->
+    <!-- example-link: src/readme-examples/all-options.example.ts -->
 
-    ```typescript
-    import {parsePdfs, ParserType} from '..';
+    ```TypeScript
+    import {parsePdfs, ParserType} from 'statement-parser';
 
     parsePdfs([
         {
@@ -118,7 +118,7 @@ ParserType.Paypal;
                  * slightly different parser options.
                  */
                 parserOptions: {
-                    /** Every parser includes this property. See Year prefix section in the README for details. */
+                    /** Every parser includes this option. See Year prefix section in the README for details. */
                     yearPrefix: 19,
                 },
             },
@@ -144,9 +144,9 @@ ParserType.Paypal;
 
 -   If you're less familiar with asynchronous programming, here's a good way (but not the _only_ way) to deal with that:
 
-    <!-- better-async.example.ts -->
+    <!-- example-link: src/readme-examples/better-async.example.ts -->
 
-    ```typescript
+    ```TypeScript
     import {parsePdfs, ParserType} from 'statement-parser';
 
     async function main() {
@@ -174,9 +174,9 @@ ParserType.Paypal;
 
 -   Parsing files can be done directly with a single parser:
 
-    <!-- direct-parsing.example.ts -->
+    <!-- example-link: src/readme-examples/direct-parsing.example.ts -->
 
-    ```typescript
+    ```TypeScript
     import {parsers, ParserType} from 'statement-parser';
 
     const parser = parsers[ParserType.Paypal];
@@ -185,9 +185,9 @@ ParserType.Paypal;
 
 -   With a single parser you can parse text lines directly (if somehow that's how your statements are stored), rather than using a PDF file:
 
-    <!-- direct-text-parsing.example.ts -->
+    <!-- example-link: src/readme-examples/direct-text-parsing.example.ts -->
 
-    ```typescript
+    ```TypeScript
     import {parsers, ParserType} from 'statement-parser';
 
     const parser = parsers[ParserType.Paypal];
diff --git a/package.json b/package.json
@@ -36,13 +36,16 @@
     "main": "dist/src/index.js",
     "typings": "dist/src/index.d.ts",
     "scripts": {
+        "format": "virmator format write",
         "prepublishOnly": "npm run test:full",
         "sanitize": "virmator compile && node dist/sanitizer/sanitize-for-test-file-cli.js",
         "sanitize:all": "./bulk-sanitize.sh files/downloads",
         "sanitize:no-compile": "node dist/sanitizer/sanitize-for-test-file-cli.js",
+        "spellcheck": "virmator spellcheck",
+        "update-docs": "virmator code-in-markdown README.md",
         "test": "virmator test",
         "test:file": "./test-specific-file.sh",
-        "test:full": "npm run test && virmator spellcheck && virmator format check"
+        "test:full": "npm run test && npm run spellcheck && npm run format check"
     },
     "dependencies": {
         "fs-extra": "^10.0.0",
diff --git a/src/readme-examples/parser-type.example.ts b/src/readme-examples/parser-type.example.ts
@@ -1,5 +1,6 @@
 import {ParserType} from '..';
 
+// possible ParserType keys
 ParserType.ChasePrimeVisaCredit;
 ParserType.CitiCostcoVisaCredit;
 ParserType.UsaaBank;
diff --git a/tsconfig.json b/tsconfig.json
@@ -16,7 +16,7 @@
         "skipDefaultLibCheck": true,
         "skipLibCheck": true,
         "strict": true,
-        "target": "es6",
+        "target": "ES2018",
         "useUnknownInCatchVariables": true
     },
     "exclude": ["node_modules", "dist", "test-repos", "scripts"]
