Setup

Author: nshiab

.eslintignore

@@ -0,0 +1 @@
+dist/

.eslintrc.json

@@ -0,0 +1,19 @@
+{
+  "env": {
+    "browser": true,
+    "es2021": true,
+    "node": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "plugins": ["@typescript-eslint"],
+  "rules": {}
+}

.github/workflows/node.js.yml

@@ -0,0 +1,32 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+    push:
+        branches: [main]
+    pull_request:
+        branches: [main]
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+
+        strategy:
+            matrix:
+                node-version: [18.x]
+                # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+        steps:
+            - uses: actions/checkout@v3
+            - name: Use Node.js ${{ matrix.node-version }}
+              uses: actions/setup-node@v3
+              with:
+                  node-version: ${{ matrix.node-version }}
+                  cache: "npm"
+            - run: npm install
+            - run: npm run check-format
+            - run: npm run lint
+            - run: npm run test
+            - run: npm run test-build

.gitignore

@@ -0,0 +1,5 @@
+node_modules
+dist/
+test/output/
+.DS_Store
+bundleSizeMin.html

.mocharc.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://json.schemastore.org/mocharc",
+  "extension": [
+    "ts"
+  ],
+  "loader": "ts-node/esm",
+  "spec": [
+    "test"
+  ]
+}

.prettierignore

@@ -0,0 +1 @@
+dist/

.prettierrc.json

@@ -0,0 +1,5 @@
+{
+  "trailingComma": "es5",
+  "tabWidth": 4,
+  "semi": false
+}

README.md

@@ -0,0 +1,12 @@
+# The Journalism Library
+
+A collection of helper functions written in TypeScrit for our journalism projects.
+
+If you wish to add one, create an issue and then open a pull request. Make sure to include:
+
+-   Tests for your function
+-   A description in this readme file.
+
+# How to install
+
+# List of helper functions