Skip to content

Commit 2e44260

Browse files
joachimvhjoachimvh
committed
chore: Initial commit
0 parents  commit 2e44260

24 files changed

+13020
-0
lines changed

‎.componentsignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[]

‎.github/.markdownlint-cli2.cjs

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
'use strict';
2+
3+
const options = require('../.markdownlint-cli2.cjs');
4+
5+
module.exports = {
6+
globs: [ '**/*.md' ],
7+
config: {
8+
// Re-use the base config
9+
...options.config,
10+
11+
// Allow first line to not be top level heading
12+
MD041: false,
13+
},
14+
};

‎.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: "\U0001F41B Bug report"
3+
about: If something is not working as expected or crashes
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
#### Environment
11+
12+
- Version: *Version of the library*
13+
- Node.js version: *Output of `node -v`*
14+
- npm version: *Output of `npm -v`*
15+
16+
#### Description
17+
<!-- Please describe the exact problem as clearly as possible. Provide any error messages thrown. -->

‎.github/ISSUE_TEMPLATE/feature-request.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
name: "➕ Feature request"
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
#### Feature description
11+
12+
<!--A clear and concise description of what you want to happen.-->

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
#### 📁 Related issues
2+
3+
<!-- Reference any relevant issues here. -->
4+
5+
#### ✍️ Description
6+
7+
<!-- Describe the relevant changes in this PR. Also add notes that might be relevant for code reviewers. -->

‎.github/dependabot.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: github-actions
4+
directory: /
5+
schedule:
6+
interval: daily
7+
time: '02:13'
8+
timezone: Europe/Brussels
9+
- package-ecosystem: npm
10+
directory: /
11+
schedule:
12+
interval: daily
13+
time: '03:35'
14+
timezone: Europe/Brussels
15+
ignore:
16+
# Ignore minor and patch version updates
17+
- dependency-name: '*'
18+
update-types: ['version-update:semver-minor', 'version-update:semver-patch']
19+
# Sticking with Husky 4.x
20+
- dependency-name: husky

‎.github/workflows/test.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Test
2+
on:
3+
push:
4+
branches:
5+
- main
6+
- 'versions/*'
7+
tags:
8+
- 'v*'
9+
pull_request:
10+
11+
jobs:
12+
lint:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/[email protected]
16+
- uses: actions/setup-node@v4
17+
with:
18+
node-version: 20.x
19+
- run: npm ci
20+
- run: npm run lint
21+
22+
test:
23+
# Run unit tests on windows and linux
24+
runs-on: ${{ matrix.operating-system }}
25+
strategy:
26+
matrix:
27+
operating-system:
28+
- ubuntu-latest
29+
- windows-latest
30+
node-version:
31+
- '18.0'
32+
- 18.x
33+
- '20.0'
34+
- 20.x
35+
- '22.1'
36+
- 22.x
37+
timeout-minutes: 15
38+
steps:
39+
- name: Use Node.js ${{ matrix.node-version }}
40+
uses: actions/setup-node@v4
41+
with:
42+
node-version: ${{ matrix.node-version }}
43+
- name: Ensure line endings are consistent
44+
run: git config --global core.autocrlf input
45+
- name: Check out repository
46+
uses: actions/[email protected]
47+
- name: Install dependencies and run build scripts
48+
run: npm ci
49+
- name: Run tests
50+
run: npm run test

‎.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/.eslintcache
2+
/componentsjs-error-state.json
3+
/coverage
4+
/dist
5+
/node_modules

‎.markdownlint-cli2.cjs

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
'use strict';
2+
3+
module.exports = {
4+
ignores: [ 'node_modules/', 'LICENSE.md', '.github/' ],
5+
6+
globs: [ '**/*.md' ],
7+
8+
config: {
9+
// Enable all markdownlint rules
10+
default: true,
11+
12+
// Set list indent level to 4 which mkdocs / Python-Markdown requires
13+
MD007: { indent: 4 },
14+
15+
// Enable line length check but exclude tables and code blocks
16+
MD013: {
17+
line_length: 120,
18+
tables: false,
19+
code_blocks: false,
20+
},
21+
22+
// Allow multiple subheadings with the same content
23+
// across different section (#1 ##A ##B #2 ##A ##B)
24+
MD024: {
25+
siblings_only: true,
26+
},
27+
28+
// Set Ordered list item prefix to "ordered" (use 1. 2. 3. not 1. 1. 1.)
29+
MD029: { style: 'ordered' },
30+
31+
// Allow inline HTML
32+
MD033: false,
33+
},
34+
};

‎.npmignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Needed to overwrite .gitignore, actual files are determined by `files` field in package.json

0 commit comments

Comments
 (0)