Commit Graph

8 Commits

Author SHA1 Message Date
Don Cross
aa334a0067 Moved code generation directories beneath 'generate'.
I'm trying to make it easier for first-time visitors to
this project to find the source code and documentation
to get started quickly. Moved directories that are only
used by contributors (mostly myself) out of the root
and into the 'generate' directory where they are less
distracting.
2021-11-23 21:23:54 -05:00
Don Cross
57177a506e Resolved security issue CVE-2021-23343.
The following security issue was reported by
Dependabot for the code generator script:

https://github.com/advisories/GHSA-hj48-42vr-x3v9

The issue was that the npm package path-parse 1.0.6
had a regex denial-of-service attack.
I have updated to use path-parse 1.0.7.

The user-facing Astronomy Engine library has no external
dependencies, so there is no need for most users to
be concerned with this change. The only affected component
was the internal code generator used to produce the
distributed source files, which is only run on my own
machine and the GitHub CI hook when I push a new change.

I verified that this update has no effect on the generated code.
2021-08-12 10:10:27 -04:00
Mateo Tibaquira
5e40c7c0c1 docs(glossary): placeholder components for each section 2021-02-09 23:29:16 -05:00
Mateo Tibaquira
992aaf4ea1 JS: Library capable of tree-shaking
I found that the Angular bundles had all the astronomy-engine library for a total of 90.62Kb
after this change Angular is able to reduce the demo module to 54.56Kb

Based on https://toastui.medium.com/building-a-ui-library-capable-of-tree-shaking-from-a-to-z-b3f8a9be589f
2021-02-08 20:09:17 -05:00
Mateo Tibaquira
cc31072506 build: generate JSON documentation with JSDoc 2021-02-07 23:38:31 -05:00
Mateo Tibaquira
f6917c9a7d JS: Improve typedef docblocks
Restored the jsdoc2md template usage for the Javascript README.md
2021-02-07 21:39:18 -05:00
Mateo Tibaquira
44a96f8c21 JS: Improve the documentation of FlexibleDateTime
Also moved the NPM commands to the package.json
so the makedoc scripts execute them in a central place.

Installed a jsdoc theme to improve the html output.
2021-02-07 20:42:05 -05:00
Mateo Tibaquira
21c053dbed JS: Refactor the build setup
The npm dependencies required are now
installed locally inside the generate folder.

Cleaned up the Astronomy object closure for TS
and kept it for the Browser bundle.

We will have some usage examples in the website.
2021-02-07 17:09:21 -05:00