Develop

.eslintignore

@@ -1,3 +0,0 @@
-/lib
-/examples/commonjs/satellite-js-migration.js
-/examples/mjs/satellite-js-migration.mjs

.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",
@@ -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",
@@ -182,7 +182,7 @@
     "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",

.github/workflows/ci.yml

@@ -74,4 +74,4 @@ jobs:
       - run: npm ci --ignore-scripts
 
       - name: Test
-        run: npm run test:nobuild
+        run: npm run test

.gitignore

@@ -1,8 +1,7 @@
 .idea
 .vscode/settings.json
 coverage
-/commonjs/
-/lib/
+dist
 node_modules
 *.log
 

.npmignore

@@ -1,24 +1,21 @@
+# Directories
 .github
 .vscode
 coverage
 examples
 node_modules
 scripts
-src/*
 test
 
 # Files
-.editorconfig
 .eslintignore
 .eslintrc
 .gitattributes
 .gitignore
 .npmignore
 .prettierrc
 babel.config.js
-codecov.yml
 jest.config.js
 package-lock.json
-sandbox.html
 tsconfig.*
 

.vscode/tasks.json

@@ -14,20 +14,20 @@
       }
     },
     {
-      "label": "Test with Jest",
-      "command": "npm test",
+      "label": "Clean Dist Folder",
+      "command": "npm run clean",
       "type": "shell",
       "args": [],
       "isBackground": true,
       "problemMatcher": [],
       "icon": {
-        "id": "go-to-file",
-        "color": "terminal.ansiGreen"
+        "id": "trash",
+        "color": "terminal.ansiYellow"
       }
     },
     {
-      "label": "Test without Building",
-      "command": "npm run test:nobuild",
+      "label": "Test for Coverage",
+      "command": "npm run test:coverage",
       "type": "shell",
       "args": [],
       "isBackground": true,
@@ -38,15 +38,25 @@
       }
     },
     {
-      "label": "Open Test Coverage",
-      "command": "npm run lcov",
-      "type": "shell",
-      "args": [],
-      "isBackground": true,
-      "problemMatcher": [],
+      "label": "Open Coverage in Brave",
+      "type": "process",
+      "command": "",
+      "windows": {
+        "command": "C:/Program Files/BraveSoftware/Brave-Browser/Application/brave.exe",
+        "args": ["${workspaceFolder}/coverage/lcov-report/index.html"]
+      },
       "icon": {
-        "id": "file-code",
-        "color": "terminal.ansiYellow"
+        "id": "browser",
+        "color": "terminal.ansiCyan"
+      },
+      "presentation": {
+        "echo": false,
+        "reveal": "never",
+        "focus": false,
+        "panel": "new",
+        "showReuseMessage": false,
+        "clear": true,
+        "close": true
       }
     }
   ],

CHANGELOG.md

@@ -4,33 +4,65 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [v1.0.0](https://github.com/thkruz/ootk-core/compare/v1.0.0-5...v1.0.0)
+
+
+
+- refactor: :recycle: standardize rng az el syntax [`59f7f53`](https://github.com/thkruz/ootk-core/commit/59f7f53c497d75bda2bf049c20e67d5191d586d7)
+- build: :memo: add auto changelog [`8abc50c`](https://github.com/thkruz/ootk-core/commit/8abc50cd4eb4b437cbea0ccaad9df5853257c386)
+- docs: :memo: update examples [`f27b230`](https://github.com/thkruz/ootk-core/commit/f27b230dfa0fb7440a81859b4057ab8d21b97ed6)
+
+#### [v1.0.0-5](https://github.com/thkruz/ootk-core/compare/v1.0.0-4...v1.0.0-5)
+
+> 15 January 2024
+
+
+- fix: :label: fix typings location in package.json [`0c9173f`](https://github.com/thkruz/ootk-core/commit/0c9173f91a5c1b6784298732cfbaa35ac9af2e37)
+
+#### [v1.0.0-4](https://github.com/thkruz/ootk-core/compare/v1.0.0-3...v1.0.0-4)
+
+> 15 January 2024
+
+
+- feat: :fire: move advanced functions to ootk [`#11`](https://github.com/thkruz/ootk-core/issues/11)
+- feat: :truck: move rf math to ootk [`#3`](https://github.com/thkruz/ootk-core/issues/3)
+- test: :white_check_mark: improve test coverage and import order [`188071e`](https://github.com/thkruz/ootk-core/commit/188071eb7b598e89a7b911685d565800de10bf6a)
+- style: :heavy_minus_sign: remove prettier and enforce stricter jsdocs [`647eff3`](https://github.com/thkruz/ootk-core/commit/647eff351ecfde1f54f9be06af8aa4dc38cc5d18)
+- docs: :page_facing_up: update copyright/license documentation [`90bdd3e`](https://github.com/thkruz/ootk-core/commit/90bdd3eff917e58c1813bff597d933891fe5645b)
+
+#### [v1.0.0-3](https://github.com/thkruz/ootk-core/compare/v1.0.0-2...v1.0.0-3)
+
+> 13 January 2024
+
+
+- ci: :construction_worker: update ci pipeline [`d82cb6c`](https://github.com/thkruz/ootk-core/commit/d82cb6c69c1135a1f77f75183eb16f47acc0110b)
+- docs: :memo: update docs [`02f0922`](https://github.com/thkruz/ootk-core/commit/02f09227bead5c8aa8cb44e1ba6b8119b34be9f6)
+- ci: :green_heart: fix ci pipeline [`21a2971`](https://github.com/thkruz/ootk-core/commit/21a297182f435aff81b3ff3a7727782a3b012511)
+
 #### [v1.0.0-2](https://github.com/thkruz/ootk-core/compare/v1.0.0-1...v1.0.0-2)
 
-- refactor: :recycle: implement strict checks in tsconfig
-  [`b1515cb`](https://github.com/thkruz/ootk-core/commit/b1515cb07794b7ac465bf27ebfb48232140f2e25)
-- feat: :sparkles: sync all commonjs es6 and typescript examples
-  [`adb58fa`](https://github.com/thkruz/ootk-core/commit/adb58faf46de6af12568064d5941026a31942ecf)
-- refactor: :recycle: standardize eci and rae methods
-  [`5581a18`](https://github.com/thkruz/ootk-core/commit/5581a18ffcb7ebbc04365e36fe49b51534c99137)
+> 12 January 2024
+
+
+- refactor: :recycle: implement strict checks in tsconfig [`b1515cb`](https://github.com/thkruz/ootk-core/commit/b1515cb07794b7ac465bf27ebfb48232140f2e25)
+- feat: :sparkles: sync all commonjs es5 and typescript examples [`adb58fa`](https://github.com/thkruz/ootk-core/commit/adb58faf46de6af12568064d5941026a31942ecf)
+- refactor: :recycle: standardize eci and rae methods [`5581a18`](https://github.com/thkruz/ootk-core/commit/5581a18ffcb7ebbc04365e36fe49b51534c99137)
 
 #### [v1.0.0-1](https://github.com/thkruz/ootk-core/compare/v1.0.0-0...v1.0.0-1)
 
 > 12 January 2024
 
-- refactor: :recycle: combine Tle classes and improve documentation
-  [`b5b506a`](https://github.com/thkruz/ootk-core/commit/b5b506af622d673fbf03fa4edbb11b405f27099f)
-- test: :white_check_mark: fix tests
-  [`4c2d701`](https://github.com/thkruz/ootk-core/commit/4c2d701dfc25d04a3929956e0ff2d5f94466bd05)
-- refactor: :recycle: move moon code to moon
-  [`7f5d7c7`](https://github.com/thkruz/ootk-core/commit/7f5d7c74b41216e75b94fbb32b07c6303cf044ec)
+
+- refactor: :recycle: combine Tle classes and improve documentation [`b5b506a`](https://github.com/thkruz/ootk-core/commit/b5b506af622d673fbf03fa4edbb11b405f27099f)
+- test: :white_check_mark: fix tests [`4c2d701`](https://github.com/thkruz/ootk-core/commit/4c2d701dfc25d04a3929956e0ff2d5f94466bd05)
+- refactor: :recycle: move moon code to moon [`7f5d7c7`](https://github.com/thkruz/ootk-core/commit/7f5d7c74b41216e75b94fbb32b07c6303cf044ec)
 
 #### v1.0.0-0
 
 > 7 January 2024
 
-- feat: :boom: initial commit
-  [`9893a6a`](https://github.com/thkruz/ootk-core/commit/9893a6acfb5dd51b12d755518c3af120fecc28be)
-- test: :truck: update names and paths
-  [`c48aece`](https://github.com/thkruz/ootk-core/commit/c48aece9a4c8a328cc7778292c4397312c162982)
-- fix: :white_check_mark: fix test paths
-  [`b784f3e`](https://github.com/thkruz/ootk-core/commit/b784f3eab311661415bfc9aa4001d9d8b8acd19f)
+
+- feat: :boom: initial commit [`9893a6a`](https://github.com/thkruz/ootk-core/commit/9893a6acfb5dd51b12d755518c3af120fecc28be)
+- test: :truck: update names and paths [`c48aece`](https://github.com/thkruz/ootk-core/commit/c48aece9a4c8a328cc7778292c4397312c162982)
+- fix: :white_check_mark: fix test paths [`b784f3e`](https://github.com/thkruz/ootk-core/commit/b784f3eab311661415bfc9aa4001d9d8b8acd19f)
+

README.md

@@ -9,8 +9,8 @@
 > An Orbital Object Toolkit in Your Web Browser
 
 **ootk-core** is the core libraries of [ootk](https://github.com/thkruz/ootk) for doing math related to orbital objects
-written in TypeScript and built for both CommonJS and ES6 JavaScript or TypeScript. **ootk-core** was developed to
-simplify the math and let you focus on using the results. It is the culmination of years of fixes and improvements to
+written in TypeScript and built for JavaScript or TypeScript. **ootk-core** was developed to simplify the math and let
+you focus on using the results. It is the culmination of years of fixes and improvements to
 other libraries.
 
 If you would like more functionality the expanded **ootk** library is available free under the AGPL license
@@ -22,16 +22,22 @@ later refactored into this library for others to use.
 
 ## :blue_book: Table of Contents
 
-- [Installation](#Installation)
-- [Usage](#Usage)
-  - [Loading the Library](#Loading-the-Library)
-  - [Propagating a TLE](#Propagating-a-TLE)
-  - [Creating a Satellite](#Creating-a-Satellite)
-  - [Creating a Sensor](#Creating-a-Sensor)
-- [Contributing](#Contributing)
-- [Building](#Building)
-- [Contributors](#Contributors)
-- [License](#License)
+- [ootk-core](#ootk-core)
+  - [:blue\_book: Table of Contents](#blue_book-table-of-contents)
+  - [:wrench: Installation](#wrench-installation)
+    - [Loading the Library](#loading-the-library)
+  - [:satellite: Usage](#satellite-usage)
+    - [Common Patterns](#common-patterns)
+    - [Propagating a TLE](#propagating-a-tle)
+    - [Creating a Satellite](#creating-a-satellite)
+    - [Creating a Sensor](#creating-a-sensor)
+    - [More Examples](#more-examples)
+  - [Changelog](#changelog)
+  - [:desktop\_computer: Building](#desktop_computer-building)
+  - [:gem: NPM Scripts](#gem-npm-scripts)
+  - [:man\_teacher: Contributing](#man_teacher-contributing)
+  - [:man\_scientist: Contributors](#man_scientist-contributors)
+  - [:balance\_scale: License](#balance_scale-license)
 
 ## :wrench: Installation
 
@@ -54,6 +60,16 @@ const satellite = new Satellite({
 
 ## :satellite: Usage
 
+### Common Patterns
+
+- If you don't specify a date, the method will assume you want to use the current date/time.
+- Many parameters are in shorthand - Ex: `sensor.rng`.
+- Changing a variable requires you to cast its units before using it as a parameters - Ex: `(3.14 * -1) as Radians`
+- Methods starting with 'to' change the class - Ex: `satellite.toGeodetic()` or `satellite.toITRF()`
+  - Methods that are optimized for loops are marked as `@variation optimized`
+  - Methods that are slower with expanded capabilities are marked as `@variation expanded`
+- Class parameters assume degrees and specify radians - Ex: `sensor.az` is in `degrees` and `sensor.azRad` is in `radians`.
+
 ### Propagating a TLE
 
 ```js
@@ -109,12 +125,22 @@ sat.rae(sensor, time); // Get position in range, aziimuth, elevation relative to
 ### Creating a Sensor
 
 ```js
-const sensor = new Ootk.Sensor({ name: 'Test', lat: lat, lon: lon, alt: alt });
+import { GroundPosition } from 'ootk-core';
+
+const sensor = new GroundPosition({ name: 'Test', lat: lat, lon: lon, alt: alt });
 sensor.rae(sat); // Get satellite position in range, aziimuth, elevation at the sensor's current time
 sensor.rae(sat, time); // Get position in range, aziimuth, elevation relative to a satellite object at the given time
 sensor.eci() // Get the sensor's position in ECI coordinates
 ```
 
+### More Examples
+
+More examples can be found in the `examples` folder of the code.
+
+## Changelog
+
+You can find a [list of changes here](https://github.com/thkruz/ootk-core/blob/main/CHANGELOG.md).
+
 ## :desktop_computer: Building
 
 1. Install [Node.js](https://nodejs.org/) and [Node Package Manager](https://www.npmjs.com/);
@@ -133,9 +159,9 @@ sensor.eci() // Get the sensor's position in ECI coordinates
 
 ## :gem: NPM Scripts
 
-- `build` compiles TypeScript into ES6 Modules in `lib` directory and CommonJs in `commonjs` directory
+- `build` compiles TypeScript into ES6 Modules in `dist` directory
 - `lint` lints source code located in `src` directory with [ESLint](http://eslint.org/)
-- `test` builds the software and then runs jest to verify the final library remains functional
+- `test` runs jest to verify the final library remains functional
 
 ## :man_teacher: Contributing
 

changelog.hbs

@@ -0,0 +1,32 @@
+### Changelog
+
+All notable changes to this project will be documented in this file. Dates are displayed in UTC.
+
+{{#each releases}}
+  {{#if href}}
+    ###{{#unless major}}#{{/unless}} [{{title}}]({{href}})
+  {{else}}
+    #### {{title}}
+  {{/if}}
+
+  {{#if tag}}
+    {{#each commits}}
+      {{#if @first}}> {{niceDate}} {{/if}}
+    {{/each}}    
+  {{/if}}
+
+  {{#if summary}}
+    {{summary}}
+  {{/if}}
+
+  {{#each merges}}
+    - {{#if commit.breaking}}**Breaking change:** {{/if}}{{message}}{{#if href}} [`#{{id}}`]({{href}}){{/if}}
+  {{/each}}
+  {{#each fixes}}
+    - {{#if commit.breaking}}**Breaking change:** {{/if}}{{commit.subject}}{{#each fixes}}{{#if href}} [`#{{id}}`]({{href}}){{/if}}{{/each}}
+  {{/each}}
+  {{#each commits}}
+    - {{#if breaking}}**Breaking change:** {{/if}}{{subject}}{{#if href}} [`{{shorthash}}`]({{href}}){{/if}}
+  {{/each}}
+
+{{/each}}