Setup: Initial files (#1)

Author: LucJosin

.editorconfig

@@ -0,0 +1,13 @@
+# Settings for editors and IDEs.
+# References at https://editorconfig.org/.
+
+root = true
+
+# Settings for any file.
+[*]
+  charset = utf-8
+  end_of_line = lf
+  indent_size = 2
+  indent_style = space
+  insert_final_newline = true
+  trim_trailing_whitespace = true

.eslintignore

@@ -0,0 +1,7 @@
+# Unlinted files and folders.
+# References at https://eslint.org/docs/user-guide/configuring#eslintignore
+
+# Generated docs, bundles and type definitions.
+docs/
+dist/
+types/

.eslintrc.json

@@ -1,23 +1,17 @@
 {
   "plugins": ["@typescript-eslint"],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaFeatures": {
+      "jsx": true
+    },
+    "ecmaVersion": 2021
+  },
   "extends": [
-    "plugin:astro/recommended",
-    "plugin:@typescript-eslint/recommended",
-    "prettier"
-  ],
-  "overrides": [
-    {
-      "files": ["*.astro"],
-      // Allows Astro components to be parsed.
-      "parser": "astro-eslint-parser",
-      // Parse the script in `.astro` as TypeScript by adding the following configuration.
-      // It's the setting you need when using TypeScript.
-      "parserOptions": {
-        "parser": "@typescript-eslint/parser",
-        "extraFileExtensions": [".astro"]
-      },
-      "rules": {}
-    }
+    "eslint:recommended",
+    "plugin:prettier/recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended"
   ],
   "rules": {
     "semi": [1, "always"],

.github/actions/setup/action.yaml

@@ -0,0 +1,23 @@
+name: 'Setup'
+description: "Setups Node.js and npm to run GitHub Actions' jobs."
+runs:
+  using: 'composite'
+  steps:
+    - name: 'Setup Node.js'
+      uses: 'actions/setup-node@v3'
+      with:
+        node-version: '16.x'
+        cache: 'npm'
+        cache-dependency-path: '**/package-lock.json'
+
+    - name: 'Keep npm cache for future workflows'
+      uses: 'actions/cache@v3'
+      with:
+        key: "${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}"
+        path: '~/.npm'
+        restore-keys: |
+          ${{ runner.os }}-node-
+
+    - name: 'Install dependencies'
+      run: 'npm ci'
+      shell: 'bash'

.github/workflows/continuous-integrations.yaml

@@ -0,0 +1,46 @@
+name: 'Continuous Integrations'
+
+on:
+  push:
+    branches: ['main']
+
+jobs:
+  lint:
+    name: 'Run ESLint and Prettier'
+    runs-on: 'ubuntu-latest'
+    steps:
+      - name: 'Checkout the repository'
+        uses: 'actions/checkout@v3'
+
+      - name: 'Setup Node.js and npm'
+        uses: './.github/actions/setup'
+
+      - name: 'Execute the lint script'
+        run: 'npm run lint'
+
+
+  test:
+    name: 'Run unit tests with Jest'
+    runs-on: 'ubuntu-latest'
+    steps:
+      - name: 'Checkout the repository'
+        uses: 'actions/checkout@v3'
+
+      - name: 'Setup Node.js and npm'
+        uses: './.github/actions/setup'
+
+      - name: 'Execute the test script'
+        run: 'npm run test'
+
+  bundle:
+    name: 'Bundle package with Rollup.js'
+    runs-on: 'ubuntu-latest'
+    steps:
+      - name: 'Checkout the repository'
+        uses: 'actions/checkout@v3'
+
+      - name: 'Setup Node.js and npm'
+        uses: './.github/actions/setup'
+
+      - name: 'Execute the build script'
+        run: 'npm run build'

.prettierignore

@@ -0,0 +1,7 @@
+# Unlinted files and folders.
+# References at https://prettier.io/docs/en/ignore.html#ignoring-files.
+
+# Generated docs, bundles and type definitions.
+docs/
+dist/
+types/

README.md

@@ -1,2 +1,7 @@
-# js-sdk
+# HawAPI - js-sdk
+
 HawAPI SDK for JavaScript/TypeScript
+
+## Repository template
+
+This library has build using [typescript-library-boilerplate](https://github.com/VitorLuizC/typescript-library-boilerplate) as template.

jest.config.js

@@ -0,0 +1,13 @@
+// @ts-check
+/* eslint-env node */
+
+/**
+ * An object with Jest options.
+ * @type {import('@jest/types').Config.InitialOptions}
+ */
+const options = {
+  preset: 'ts-jest',
+  resolver: 'ts-jest-resolver',
+};
+
+module.exports = options;

package.json

@@ -14,20 +14,55 @@
     "email": "[email protected]"
   },
   "license": "MIT",
-  "main": "index.js",
   "keywords": [
     "hawapi",
     "hawapi-js-sdk",
     "haw-api",
     "stranger-things",
     "stranger-things-api"
   ],
+  "cdn": "dist/index.umd.js",
+  "main": "dist/index.js",
+  "types": "types/index.d.ts",
+  "unpkg": "dist/index.umd.js",
+  "module": "dist/index.esm.js",
+  "jsdelivr": "dist/index.umd.js",
+  "umd:main": "dist/index.umd.js",
+  "exports": {
+    ".": [
+      {
+        "import": "./dist/index.mjs",
+        "require": "./dist/index.cjs",
+        "default": "./dist/index.js"
+      },
+      "./dist/index.js"
+    ]
+  },
+  "scripts": {
+    "test": "jest",
+    "lint": "eslint \"*/**/*.{ts,js,json}\"",
+    "lint:fix": "eslint \"*/**/*.{ts,js,json}\" --fix",
+    "clear": "rm -rf ./dist/",
+    "build": "yarn clear && rollup --config ./rollup.config.mjs",
+    "pre-publish": "yarn lint && yarn test && yarn build",
+    "pre-publish-wot": "yarn lint && yarn build"
+  },
   "devDependencies": {
-    "typescript": "^4.1.2",
-    "@typescript-eslint/eslint-plugin": "^4.22.0",
-    "@typescript-eslint/parser": "^4.22.0",
-    "eslint": "^7.24.0",
+    "@types/eslint": "^8.4.10",
+    "@types/jest": "^29.2.4",
+    "@types/prettier": "^2.7.2",
+    "@typescript-eslint/eslint-plugin": "^5.47.0",
+    "@typescript-eslint/parser": "^5.47.0",
+    "eslint": "^8.30.0",
     "eslint-config-prettier": "^8.5.0",
-    "prettier": "^2.8.1"
+    "eslint-plugin-prettier": "^4.2.1",
+    "jest": "^29.3.1",
+    "prettier": "^2.8.1",
+    "rollup": "^2.79.1",
+    "rollup-plugin-terser": "^7.0.2",
+    "rollup-plugin-typescript2": "^0.34.1",
+    "ts-jest": "^29.0.3",
+    "ts-jest-resolver": "^2.0.0",
+    "typescript": "^4.9.4"
   }
 }

rollup.config.mjs

@@ -0,0 +1,83 @@
+// @ts-check
+
+import { readFile } from 'node:fs/promises';
+
+import { terser } from 'rollup-plugin-terser';
+import typescript2 from 'rollup-plugin-typescript2';
+
+const packageJSON = JSON.parse(await readFile('./package.json', 'utf-8'));
+
+const today = Date().split(' ').splice(1, 3).join(' ');
+
+/**
+ * Comment with library information to be appended in the generated bundles.
+ */
+const banner = `/*!
+ * v${packageJSON.version}
+ * ${packageJSON.name} (${today})
+ * 
+ * Website: https://hawapi.theproject.id
+ * Docs: https://hawapi.theproject.id/docs
+ * Github: https://github.com/HawAPI/js-sdk
+ * 
+ * (c) ${packageJSON.author.name}
+ * Released under the ${packageJSON.license} License.
+ */
+`;
+
+/**
+ * Creates an output options object for Rollup.js.
+ * @param {import('rollup').OutputOptions} options
+ * @returns {import('rollup').OutputOptions}
+ */
+function createOutputOptions(options) {
+  return {
+    banner,
+    name: 'HawAPI',
+    exports: 'named',
+    sourcemap: true,
+    ...options,
+  };
+}
+
+/**
+ * @type {import('rollup').RollupOptions}
+ */
+const options = {
+  input: './src/index.ts',
+  output: [
+    createOutputOptions({
+      file: './dist/index.js',
+      format: 'commonjs',
+    }),
+    createOutputOptions({
+      file: './dist/cjs/index.cjs',
+      format: 'commonjs',
+    }),
+    createOutputOptions({
+      file: './dist/esm/index.mjs',
+      format: 'esm',
+    }),
+    createOutputOptions({
+      file: './dist/esm/index.esm.js',
+      format: 'esm',
+    }),
+    createOutputOptions({
+      file: './dist/umd/index.umd.js',
+      format: 'umd',
+    }),
+    createOutputOptions({
+      file: './dist/umd/index.umd.min.js',
+      format: 'umd',
+      plugins: [terser()],
+    }),
+  ],
+  plugins: [
+    typescript2({
+      clean: true,
+      useTsconfigDeclarationDir: true,
+    }),
+  ],
+};
+
+export default options;