Merge pull request #24 from thkruz/develop

Version 4.0.0
thkruz · Jun 25, 2024 · 70dda63 · 70dda63
2 parents e485a79 + 7e45f62
commit 70dda63
Show file tree

Hide file tree

Showing 306 changed files with 11,107 additions and 1,983,358 deletions.
diff --git a/.auto-changelog b/.auto-changelog
@@ -0,0 +1,8 @@
+{
+  "output": "CHANGELOG.md",
+  "template": "changelog.hbs",
+  "package": true,
+  "hideCredit": true,
+  "tagPrefix": "v",
+  "commitLimit": false
+}
diff --git a/.eslintignore b/.eslintignore
@@ -1,3 +0,0 @@
-/dist
-/lib
-/src/sgp4/asc

diff --git a/.eslintrc.json b/.eslintrc.json
@@ -5,13 +5,13 @@
     "node": true,
     "jest": true
   },
-  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended", "plugin:jsdoc/recommended-typescript-error"],
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
     "ecmaVersion": 12,
     "sourceType": "module"
   },
-  "plugins": ["@typescript-eslint"],
+  "plugins": ["@typescript-eslint", "jsdoc"],
   "rules": {
     "accessor-pairs": "error",
     "array-bracket-newline": "error",
@@ -27,7 +27,7 @@
     "callback-return": "error",
     "camelcase": "error",
     "capitalized-comments": "off",
-    "class-methods-use-this": "error",
+    "class-methods-use-this": "off",
     "comma-dangle": ["error", "always-multiline"],
     "comma-spacing": "error",
     "comma-style": "error",
@@ -39,14 +39,14 @@
     "default-case": "error",
     "default-case-last": "error",
     "default-param-last": "error",
-    "dot-location": "error",
+    "dot-location": "off",
     "dot-notation": "error",
     "eol-last": "error",
     "eqeqeq": "error",
     "func-call-spacing": "error",
     "func-name-matching": "error",
     "func-names": "error",
-    "func-style": "error",
+    "func-style": "off",
     "function-call-argument-newline": "off",
     "function-paren-newline": "off",
     "generator-star-spacing": "error",
@@ -61,7 +61,7 @@
     "implicit-arrow-linebreak": "off",
     "indent": ["error", 2, { "SwitchCase": 1 }],
     "indent-legacy": ["error", 2, { "SwitchCase": 1 }],
-    "init-declarations": "error",
+    "init-declarations": "off",
     "jsx-quotes": "error",
     "key-spacing": "error",
     "keyword-spacing": "error",
@@ -76,8 +76,8 @@
     "max-lines": ["error", { "max": 1000 }],
     "max-lines-per-function": ["error", { "max": 300 }],
     "max-nested-callbacks": "error",
-    "max-params": ["error", { "max": 5 }],
-    "max-statements": ["error", { "max": 25 }],
+    "max-params": ["error", { "max": 8 }],
+    "max-statements": ["error", { "max": 85 }],
     "max-statements-per-line": "error",
     "multiline-comment-style": "error",
     "multiline-ternary": "off",
@@ -89,14 +89,14 @@
     "no-alert": "error",
     "no-array-constructor": "error",
     "no-await-in-loop": "error",
-    "no-bitwise": "error",
+    "no-bitwise": "off",
     "no-buffer-constructor": "error",
     "no-caller": "error",
     "no-catch-shadow": "error",
     "no-confusing-arrow": "error",
     "no-console": "error",
     "no-constructor-return": "error",
-    "no-continue": "error",
+    "no-continue": "off",
     "no-div-regex": "error",
     "no-duplicate-imports": "error",
     "no-else-return": "error",
@@ -108,7 +108,7 @@
     "no-extra-label": "error",
     "no-extra-parens": "off",
     "no-floating-decimal": "error",
-    "no-implicit-coercion": "error",
+    "no-implicit-coercion": "off",
     "no-implicit-globals": "error",
     "no-implied-eval": "error",
     "no-inline-comments": "off",
@@ -163,7 +163,7 @@
     "no-template-curly-in-string": "error",
     "no-ternary": "off",
     "no-throw-literal": "error",
-    "no-trailing-spaces": "error",
+    "no-trailing-spaces": ["error", { "ignoreComments": true }],
     "no-undef-init": "error",
     "no-undefined": "error",
     "no-underscore-dangle": "off",
@@ -177,12 +177,12 @@
     "no-useless-call": "error",
     "no-useless-computed-key": "error",
     "no-useless-concat": "error",
-    "no-useless-constructor": "error",
+    "no-useless-constructor": "off",
     "no-useless-rename": "error",
     "no-useless-return": "error",
     "no-var": "error",
     "no-void": "error",
-    "no-warning-comments": "error",
+    "no-warning-comments": "warn",
     "no-whitespace-before-property": "error",
     "nonblock-statement-body-position": "error",
     "object-curly-newline": "error",
@@ -197,7 +197,7 @@
     "padding-line-between-statements": "error",
     "prefer-arrow-callback": "error",
     "prefer-const": "error",
-    "prefer-destructuring": "error",
+    "prefer-destructuring": "off",
     "prefer-exponentiation-operator": "error",
     "prefer-named-capture-group": "error",
     "prefer-numeric-literals": "error",

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -3,78 +3,75 @@ name: CI
 on: [pull_request]
 
 jobs:
-  build:
+  compliance:
+    name: NPM Audit Report
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-
-      - name: Load cached modules
-        uses: actions/cache@v2
+      # Checkout Code
+      - name: Checkout Code
+        uses: actions/checkout@v4
+      # Audit Package.json
+      - name: NPM Audit Action
+        uses: oke-py/npm-audit-action@main
         with:
-          path: |
-            **/node_modules
-          key: ${{ runner.os }}-modules-${{ hashFiles('**/package-lock.json') }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+  lint:
+    needs: compliance
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/[email protected]
 
-      - name: Load Node.js latest
-        uses: actions/setup-node@v2-beta
+      - uses: actions/[email protected]
         with:
-          node-version: '17.x'
+          node-version: '20.x'
 
-      - name: Install all dependencies
-        run: npm install
+      - run: npm ci --ignore-scripts
 
-      - name: Compile TypeScript and build UMD files
-        run: npm run build
-
-  lint:
-    name: lint
-    needs: build
+      - run: npm run lint
+  build:
+    needs: lint
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
+      - uses: actions/[email protected]
 
-      - name: Use Node.js latest
-        uses: actions/setup-node@v2-beta
+      - uses: actions/[email protected]
         with:
-          node-version: '17.x'
+          node-version: '20.x'
 
-      - name: Get cached modules
-        uses: actions/cache@v2
+      - uses: actions/cache@v3
+        env:
+          cache-name: cache-node-modules
         with:
           path: |
-            **/node_modules
-          key: ${{ runner.os }}-modules-${{ hashFiles('**/package-lock.json') }}
+            **/lib
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
 
-      - name: Run ESLint
-        run: npm run lint
+      - run: npm ci --ignore-scripts
 
-  test-coverage:
-    name: test-coverage
+      - run: npm run build
+  test:
     needs: build
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
+      - uses: actions/[email protected]
 
-      - name: Use Node.js latest
-        uses: actions/setup-node@v2-beta
+      - uses: actions/[email protected]
         with:
-          node-version: '17.x'
+          node-version: '20.x'
 
-      - name: Get cached modules
-        uses: actions/cache@v2
+      - uses: actions/cache@v3
+        env:
+          cache-name: cache-node-modules
         with:
           path: |
-            **/node_modules
-          key: ${{ runner.os }}-modules-${{ hashFiles('**/package-lock.json') }}
-
-      - name: Compile TypeScript and build UMD files
-        run: npm run build
+            **/lib
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
 
-      - name: Build coverage
-        run: npm run test:coverage
+      - run: npm ci --ignore-scripts
 
-      - name: Run codecov
-        run: node ./node_modules/.bin/codecov
+      - name: Test
+        run: npm run test
diff --git a/.gitignore b/.gitignore
@@ -1,19 +1,8 @@
 .idea
-.vscode
+.vscode/settings.json
 coverage
 dist
-lib
 node_modules
 *.log
 
-built
-
-test/performance
-test/satellite/transform*
-test/sgp4/sgp4prop
-
-# Future assembly work
-asc
-.asc
-
 **/**.out
diff --git a/.npmignore b/.npmignore
@@ -1,16 +1,22 @@
+# Directories
 .github
 .vscode
 coverage
+examples
 node_modules
 scripts
-src/*
 test
-.babelrc
+
+# Files
+.auto-changelog
 .eslintignore
-.eslintrc
+.eslintrc.json
 .gitattributes
 .gitignore
 .npmignore
+babel.config.cjs
+changelog.hbs
+jest.config.ts
 package-lock.json
-tsconfig.json
+tsconfig.*
 
diff --git a/.prettierrc b/.prettierrc