feat: docs + CI/CD

Author: SamuelScheit

.github/workflows/deploy.yml

@@ -0,0 +1,40 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+    # Review gh actions docs if you want to further define triggers, paths, etc
+    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
+
+jobs:
+  deploy:
+    name: Deploy to GitHub Pages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: yarn
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Build website
+        run: yarn build
+
+      # Popular action to deploy to GitHub Pages:
+      # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          # Build output to publish to the `gh-pages` branch:
+          publish_dir: ./build
+          # The following lines assign commit authorship to the official
+          # GH-Actions bot for deploys to `gh-pages` branch:
+          # https://github.com/actions/checkout/issues/13#issuecomment-724415212
+          # The GH actions bot is used by default if you didn't specify the two fields.
+          # You can swap them out with your own user credentials.
+          user_name: github-actions[bot]
+          user_email: 41898282+github-actions[bot]@users.noreply.github.com

.gitignore

@@ -1,4 +1,6 @@
 docs/
+build/
+.docusaurus/
 # Logs
 logs
 *.log
@@ -106,4 +108,4 @@ typings/
 
 # TernJS port file
 .tern-port
-.DS_Store
+.DS_Store

README.md

@@ -2,18 +2,18 @@
 [![npm downloads][npm-downloads-src]][npm-downloads-href]
 
 <h1 align="center">Missing Native
-	<img width="24" src="https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/javascript/javascript.png">
+	<img width="24" src="https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/javascript/javascript.png" />
 	Functions</h1>
 <p align="center">A zero-dependecy JavaScript utility library delivering <b>missing</b> native functions 💼</p>
 
 ## Why use mnjsf?
 
 mnjsf delivers functions missing from JavaScript
 
-❯ 💼 **Zero-Dependency** Built without a dependency hell<br>
-❯ 📐 **Lightweight** 2.5KB<br>
-❯ 🌐 **NodeJS/Browser Support** use mnjsf in a browser or a Node.js application <br>
-❯ ✨ **Direct Call** of utility functions on variables (`[].last()`) <br>
+❯ 💼 **Zero-Dependency** Built without a dependency hell<br />
+❯ 📐 **Lightweight** 2.5KB<br />
+❯ 🌐 **NodeJS/Browser Support** use mnjsf in a browser or a Node.js application <br />
+❯ ✨ **Direct Call** of utility functions on variables (`[].last()`) <br />
 
 This library extends the properties of `Array`, `Object`, `Promise`, `Global`, `Math`, `Number` and `String`
 
@@ -46,10 +46,9 @@ use in Browser
 <script src="https://cdn.jsdelivr.net/npm/missing-native-js-functions/dist/mnjsf.min.js"></script>
 ```
 
-
 ## License
 
-Made with 💚 Published under [MIT](./LICENSE).
+Made with 💚 Published under MIT License.
 
 <!-- Badges -->
 

docusaurus.config.js

@@ -0,0 +1,54 @@
+// @ts-nocheck
+
+try {
+	require("fs").mkdirSync(__dirname + "/docs", { recursive: true });
+} catch (error) {}
+
+const entryPoints = require("fs")
+	.readdirSync(__dirname + "/src")
+	.map((x) => __dirname + "/src/" + x);
+
+const organizationName = "trantlabs";
+const projectName = "missing-native-js-functions";
+const githubUrl = `https://github.com/${organizationName}/${projectName}`;
+
+/** @type {import('typedoc').TypeDocOptions} */
+const typedoc = {
+	tsconfig: __dirname + "/tsconfig.json",
+	entryPoints: entryPoints,
+	out: __dirname + "/docs/",
+	watch: process.env.TYPEDOC_WATCH,
+};
+
+/** @type {import('@docusaurus/types').Config} */
+const config = {
+	title: "Missing Native JS Functions",
+	tagline: "A zero-dependecy JavaScript utility library delivering missing native functions 💼",
+	url: `https://${organizationName}.github.io/`,
+	organizationName,
+	projectName,
+	deploymentBranch: "gh-pages",
+	baseUrl: `/${projectName}/`,
+	onBrokenLinks: "throw",
+	onBrokenMarkdownLinks: "warn",
+	organizationName: "trantlabs",
+	projectName: "missing-native-js-functions",
+	presets: [
+		[
+			"@docusaurus/preset-classic",
+			{
+				docs: {
+					path: "./docs/",
+					routeBasePath: "/",
+					editUrl: `${githubUrl}/edit/master/website`,
+				},
+			},
+		],
+	],
+	plugins: [["docusaurus-plugin-typedoc", typedoc]],
+	themeConfig: {
+		navbar: {},
+	},
+};
+
+module.exports = config;

package.json

@@ -11,7 +11,9 @@
 		"build": "tsc -b .",
 		"rollup": "rollup -c",
 		"release": "yarn build && yarn rollup && changelogen --bump --output=CHANGELOG.md && git push --follow-tags && yarn publish",
-		"lint": "eslint --ext .js,.ts"
+		"lint": "eslint --ext .js,.ts",
+		"docs": "TYPEDOC_WATCH=true docusaurus start",
+		"docs:build": "docusaurus build"
 	},
 	"repository": {
 		"type": "git",
@@ -39,14 +41,26 @@
 	},
 	"homepage": "https://trantlabs.github.io/missing-native-js-functions/",
 	"devDependencies": {
+		"@docusaurus/core": "2.2.0",
+		"@docusaurus/module-type-aliases": "2.2.0",
+		"@docusaurus/preset-classic": "2.2.0",
+		"@mdx-js/react": "^1.6.22",
 		"@trantlabs/eslint-config-typescript": "^0.0.0",
 		"@types/node": "^14.14.14",
 		"changelogen": "^0.4.0",
+		"clsx": "^1.2.1",
+		"docusaurus-plugin-typedoc": "^0.18.0",
 		"eslint": "^8.30.0",
+		"patch-package": "^6.5.0",
+		"prism-react-renderer": "^1.3.5",
+		"react": "^17.0.2",
+		"react-dom": "^17.0.2",
 		"rollup": "^2.36.1",
 		"rollup-plugin-babel-minify": "^10.0.0",
 		"rollup-plugin-commonjs": "^10.1.0",
 		"rollup-plugin-node-resolve": "^5.2.0",
+		"typedoc": "^0.23.23",
+		"typedoc-plugin-markdown": "^3.14.0",
 		"typescript": "^4.4.3"
 	}
 }

src/Date.ts

@@ -1,9 +1,9 @@
 import { define } from "./Util";
 
 define(Date, {
-    nowSeconds: function () {
-        return Math.floor(Date.now() / 1000);
-    },
+	nowSeconds: function () {
+		return Math.floor(Date.now() / 1000);
+	},
 });
 
 define(Date.prototype, {
@@ -22,15 +22,15 @@ define(Date.prototype, {
 });
 
 declare global {
-    interface DateConstructor {
+	interface DateConstructor {
 		/**
 		 * Returns the current timestamp as its representation in seconds
 		 * @returns {number} date in seconds
 		 * @example
-		 * new Date().nowSeconds() // 1671621321
+		 * Date.nowSeconds() // 1671621321
 		 */
 		nowSeconds(): number;
-    }
+	}
 }
 
 declare global {

src/index.ts

@@ -6,3 +6,12 @@ import "./Object";
 import "./Promise";
 import "./String";
 import "./Date";
+
+export * from "./Array";
+export * from "./Global";
+export * from "./Math";
+export * from "./Number";
+export * from "./Object";
+export * from "./Promise";
+export * from "./String";
+export * from "./Date";