Skip to content

Commit

Permalink
Initial checkin
Browse files Browse the repository at this point in the history
  • Loading branch information
hildjj committed Oct 7, 2024
0 parents commit 20f0489
Show file tree
Hide file tree
Showing 18 changed files with 2,487 additions and 0 deletions.
10 changes: 10 additions & 0 deletions .c8rc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"reporter": [
"text",
"lcov"
],
"exclude": [
"**/test/**",
"**/node_modules/**"
]
}
12 changes: 12 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# EditorConfig is awesome: http://EditorConfig.org

# top-most EditorConfig file
root = true

[*]
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
charset = utf-8
indent_style = space
indent_size = 2
17 changes: 17 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
*.js text eol=lf
*.cjs text eol=lf
*.mjs text eol=lf
*.ts text eol=lf
*.tsx text eol=lf
*.peggy text eol=lf
*.pegjs text eol=lf
*.peg.js text eol=lf
*.json text eol=lf
*.html text eol=lf
*.css text eol=lf
*.map text eol=lf
*.png binary
*.jpg binary
*.ico binary
*.pdf binary
docs/* binary
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
github: [hildjj]
38 changes: 38 additions & 0 deletions .github/workflows/node.js.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Tests

on:
push:
branches: [main]
pull_request:
branches: [main]

jobs:
build:

strategy:
matrix:
node-version: [18.x, 20.x, 22.x]
platform: [ubuntu-latest]

runs-on: ${{ matrix.platform }}

steps:
- uses: actions/checkout@v4
with:
submodules: true
- name: Install pnpm
run: corepack enable
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
cache: 'pnpm'
- name: Dependencies
run: pnpm install -r
- name: Test ${{ matrix.node-version }} ${{ matrix.platform }}
run: npm run build
- name: Upload coverage reports to Codecov
uses: codecov/codecov-action@v4
with:
token: ${{ secrets.CODECOV_TOKEN }}
32 changes: 32 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Publish Package to npmjs
on:
release:
types: [published]
jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: write
id-token: write
steps:
- uses: actions/checkout@v4
- run: corepack enable
- uses: actions/setup-node@v4
with:
node-version: '20.x'
registry-url: 'https://registry.npmjs.org'
cache: pnpm
- run: pnpm i -r
- run: npm run build
- run: npm pkg delete devDependencies
- name: Rebuild pnpm-lock.yaml
run: pnpm i --no-frozen-lockfile
- name: Deploy Docs
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs
publish_branch: gh-pages
- run: npm publish --access public --provenance
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
coverage/
docs/
lib/
node_modules/
3 changes: 3 additions & 0 deletions .ncurc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"dep": ["prod", "dev", "packageManager"]
}
12 changes: 12 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.c8rc
.editorconfig
.gitattributes
.github/
.ncurc
coverage/
docs/
eslint.config.js
src/
test/
tsconfig.json
typedoc.config.cjs
19 changes: 19 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Copyright® 2024 The @cto.af/generate-rules-table Authors and Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the “Software”), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# @cto.af/generate-rules-table

Description

## Installation

```sh
npm install @cto.af/generate-rules-table
```

## API

Full [API documentation](http://cto-af.github.io/generate-rules-table/) is available.

Example:

```js
```

---
[![Build Status](https://github.com/cto-af/generate-rules-table/workflows/Tests/badge.svg)](https://github.com/cto-af/generate-rules-table/actions?query=workflow%3ATests)
[![codecov](https://codecov.io/gh/cto-af/generate-rules-table/branch/main/graph/badge.svg?token=N7B7YLIDM4)](https://codecov.io/gh/cto-af/generate-rules-table)
22 changes: 22 additions & 0 deletions eslint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import es6 from '@cto.af/eslint-config/es6.js';
import jsdoc from '@cto.af/eslint-config/jsdoc.js';
import jts from '@cto.af/eslint-config/jsdoc_ts.js';
import markdown from '@cto.af/eslint-config/markdown.js';
import mod from '@cto.af/eslint-config/module.js';
import ts from '@cto.af/eslint-config/ts.js';

export default [
{
ignores: [
'**/*.d.ts',
'lib/**',
'docs/**',
],
},
...es6,
...mod,
...ts,
...jsdoc,
...jts,
...markdown,
];
41 changes: 41 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
{
"name": "@cto.af/generate-rules-table",
"version": "0.0.0",
"decription": "",
"main": "lib/index.js",
"type": "module",
"keywords": [],
"author": "Joe Hildebrand <joe-github@cursive.net>",
"license": "MIT",
"repository": {
"type": "git",
"url": "git+https://github.com/cto-af/generate-rules-table.git"
},
"homepage": "https://github.com/cto-af/generate-rules-table#readme",
"bugs": {
"url": "https://github.com/cto-af/generate-rules-table/issues"
},
"scripts": {
"clean": "rm -rf coverage docs lib",
"lint": "eslint .",
"pretest": "tsc --inlineSourceMap",
"test": "c8 node --test",
"posttest": "npm run ts",
"docs": "typedoc",
"ts": "tsc",
"build": "npm run test && npm run lint && npm run docs && npm pack --dry-run"
},
"devDependencies": {
"@cto.af/eslint-config": "4.1.6",
"c8": "10.1.2",
"eslint-plugin-jsdoc": "50.3.1",
"eslint-plugin-markdown": "5.1.0",
"typedoc": "0.26.8",
"typescript-eslint": "8.8.1",
"typescript": "5.6.2"
},
"packageManager": "pnpm@9.12.1",
"engines": {
"node": ">=18"
}
}
Loading

0 comments on commit 20f0489

Please sign in to comment.