Update Packages (#156)

* Updating mocha package * Updating spacing, updating eslint, removing documentation, fixing lint issues * Updating * Use mocha globals * Fixing ESlint * Fixing ESlint * Updating Docs * Updating CodeQL * Updating style * Updating checkout action --------- Co-authored-by: Sean Thomas Burke <[email protected]>
seantomburke · Nov 8, 2024 · 4fe44a2 · 4fe44a2
1 parent 5c66722
commit 4fe44a2
Show file tree

Hide file tree

Showing 24 changed files with 3,883 additions and 9,073 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -10,14 +10,14 @@
 # supported CodeQL languages.
 # ******** NOTE ********
 
-name: "CodeQL"
+name: 'CodeQL'
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ master ]
+    branches: [master]
   schedule:
     - cron: '34 0 * * 1'
 
@@ -29,40 +29,40 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        language: [ 'javascript' ]
+        language: ['javascript']
         # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
         # Learn more...
         # https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v2
+      - name: Checkout repository
+        uses: actions/checkout@v4
 
-    # 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
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        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
+      # 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@v2
 
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
+      # ℹ️ 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
+      # ✏️ 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
+      #- run: |
+      #   make bootstrap
+      #   make release
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -5,25 +5,24 @@ name: test
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
   pull_request:
-    branches: [ master ]
+    branches: [master]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
         node-version: [16.x, 18.x, 20.x]
 
     steps:
-    - uses: actions/checkout@v4
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
-      with:
-        node-version: ${{ matrix.node-version }}
-    - run: npm ci
-    - run: npm run build --if-present
-    - run: npm test
+      - uses: actions/checkout@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm run build --if-present
+      - run: npm test
diff --git a/.github/workflows/version-bump.yml b/.github/workflows/version-bump.yml
@@ -15,32 +15,32 @@ jobs:
     outputs:
       nodeVersion: ${{ steps.bump_version.outputs.version }}
     steps:
-    - uses: actions/checkout@v4
-    - name: Use Node.js 20
-      uses: actions/setup-node@v4
-      with:
-        node-version: '20'
-    - name: bump version
-      id: bump_version
-      run: |
-        git config --local user.email "[email protected]"
-        git config --local user.name "GitHub Action"
-        echo "::set-output name=version::$(echo $(node -p "require('./package.json').version.trim()"))"
-        npm version patch
-        git push
+      - uses: actions/checkout@v4
+      - name: Use Node.js 20
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+      - name: bump version
+        id: bump_version
+        run: |
+          git config --local user.email "[email protected]"
+          git config --local user.name "GitHub Action"
+          echo "::set-output name=version::$(echo $(node -p "require('./package.json').version.trim()"))"
+          npm version patch
+          git push
   release:
     runs-on: ubuntu-latest
     needs: build
     steps:
-    - name: draft release
-      id: draft_release
-      uses: actions/create-release@v1
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
-      with:
-        tag_name: ${{ needs.build.outputs.nodeVersion }}
-        release_name: Release ${{ needs.build.outputs.nodeVersion }}
-        body: |
-          Releasing version ${{ needs.build.outputs.nodeVersion }} to NPM
-        draft: true
-        prerelease: false
+      - name: draft release
+        id: draft_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
+        with:
+          tag_name: ${{ needs.build.outputs.nodeVersion }}
+          release_name: Release ${{ needs.build.outputs.nodeVersion }}
+          body: |
+            Releasing version ${{ needs.build.outputs.nodeVersion }} to NPM
+          draft: true
+          prerelease: false
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,5 @@
+node_modules
+dist
+build
+coverage
+package-lock.json 
diff --git a/.prettierrc.js b/.prettierrc.js
@@ -0,0 +1,8 @@
+module.exports = {
+  semi: true,
+  trailingComma: 'es5',
+  singleQuote: true,
+  printWidth: 80,
+  tabWidth: 2,
+  endOfLine: 'lf',
+};
diff --git a/.travis.yml b/.travis.yml
@@ -1,7 +1,7 @@
 language: node_js
 node_js:
-  - "14.15.0"
-  - "12.13.0"
-  - "10"
+  - '14.15.0'
+  - '12.13.0'
+  - '10'
 after_success:
   - bash <(curl -s https://codecov.io/bash)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,15 +1,17 @@
 ## Contributing
 
-The files to modify are under the `src` folder. `src/assets` are JavaScript files written in es6 that get compiled
+The files to modify are under the `src` folder. `src/assets` are JavaScript files written in JavaScript that get compiled
 through babel into `lib/sitemapper.js`.
 
 ### Build
 
 To build the `lib` directory with the compiled assets use this command
+
 ```bash
 npm run build
 ```
-This uses [Babel](http://babeljs.io/) to compile the files. Make sure to run `npm run build` before submitting a pull request.
+
+This uses [Babel](http://babeljs.io/) to compile the files. The prepack step will run `npm run build` when submitting a pull request.
 
 ```bash
 # Run examples/index.js
@@ -19,16 +21,19 @@ npm start
 ### Testing
 
 Make sure all tests pass using
+
 ```bash
 npm test
 ```
+
 This will run [Mocha](https://mochajs.org/) for testing and [ESLint](http://eslint.org/) for style guides
 The tests run will be `mocha` and `eslint`.
 Make sure your style follows the style guide in `.eslintrc`
 
 ### Style Guide
 
 To see if your code passes the linter use
+
 ```bash
 npm run lint
 ```
@@ -53,7 +58,10 @@ src/
   assets/
     sitemapper.js
   examples/
+    google.js
     index.js
   tests/
     test.js
-````
+    test.ts.ts
+    tsconfig.json
+```