Initial commit

Author: jviide

.devcontainer/Dockerfile

@@ -0,0 +1,5 @@
+FROM node:18-alpine
+RUN apk add --no-cache \
+  git \
+  openssh \
+  ripgrep

.devcontainer/devcontainer.json

@@ -0,0 +1,22 @@
+{
+  "name": "eol-rules",
+
+  "build": {
+    "dockerfile": "./Dockerfile",
+    "context": "."
+  },
+
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "dbaeumer.vscode-eslint",
+        "esbenp.prettier-vscode",
+        "redhat.vscode-yaml"
+      ]
+    }
+  },
+
+  "postStartCommand": "npm ci",
+
+  "remoteUser": "node"
+}

.github/workflows/main.yml

@@ -0,0 +1,48 @@
+name: Validate, build and deploy
+
+on: [push, pull_request]
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: npm
+      - run: npm ci
+      - run: npm run lint
+      - run: npm run typecheck
+      - run: npm run validate
+  build:
+    if: github.ref == 'refs/heads/main'
+    needs: check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: npm
+      - run: npm ci
+      - run: |
+          mkdir pages
+          npm -s run collect > pages/eol-rules.json
+      - uses: actions/upload-pages-artifact@v1
+        with:
+          path: pages
+  deploy:
+    if: github.ref == 'refs/heads/main'
+    needs: build
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

.gitignore

@@ -0,0 +1,104 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and *not* Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port

.vscode/settings.json

@@ -0,0 +1,17 @@
+{
+  "editor.formatOnSave": true,
+  "eslint.format.enable": true,
+  "eslint.validate": ["javascript", "typescript"],
+  "explorer.excludeGitIgnore": true,
+  "yaml.format.enable": false,
+  "yaml.validate": true,
+  "yaml.schemas": {
+    "./schema/target.schema.json": "/targets/*.yaml"
+  },
+  "[json][jsonc][yaml]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[javascript][typescript]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  }
+}

README.md

@@ -0,0 +1,30 @@
+# EOL Rule Database [![Validate, build and deploy](https://github.com/badrap/eol-rules/actions/workflows/main.yml/badge.svg)](https://github.com/badrap/eol-rules/actions/workflows/main.yml)
+
+The collected rules are published to GitHub pages on every push to the `main` branch:
+
+- https://badrap.github.io/eol-rules/rules.json - A JSON collection of rules.
+
+## Getting Started
+
+This repository has a Dev Container setup that can be used with Visual Studio Code. Refer to the article ["Developing inside a Container"](https://code.visualstudio.com/docs/devcontainers/containers) to get started.
+
+## Structure
+
+Each target has their own .yaml file under the the [./targets](./targets) directory. The target's canonical identifier (_"target ID"_) is derived from the filename by removing the .yaml suffix.
+
+A valid target ID follows these rules:
+
+- It must have 1-32 characters.
+- It must contain only hyphens and lowercase alphanumerics.
+- It must start and end with an alphanumeric.
+- It must not contain two consecutive hyphens.
+
+## Target file validation
+
+Target files are validated on every push by GitHub Actions. You can also run validation locally with the following command:
+
+```sh
+npm run validate
+```
+
+The validation uses the [./schema/target.schema.json](./schema/target.schema.json) file to check the basic structure of each target YAML file.