Skip to content

Commit

Permalink
Initial commit of plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
jduncan-xoi committed Aug 8, 2022
0 parents commit 49ca8a7
Show file tree
Hide file tree
Showing 30 changed files with 7,914 additions and 0 deletions.
21 changes: 21 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
module.exports = {
root: true,
env: {
node: true,
es6: true,
},
parserOptions: {
ecmaVersion: 2017,
},
parser: '@typescript-eslint/parser',
plugins: ['@typescript-eslint'],
extends: [
'eslint:recommended',
'plugin:@typescript-eslint/eslint-recommended',
'plugin:@typescript-eslint/recommended',
'plugin:prettier/recommended',
],
rules: {
'@typescript-eslint/no-explicit-any': 'warn',
},
}
16 changes: 16 additions & 0 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
tests:
- test/**/*

core:
- src/**/*

dependencies:
- yarn.lock
- package.json

internal:
- CHANGES.md
- LICENSE

documentation:
- README.md
31 changes: 31 additions & 0 deletions .github/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
change-template: '* $TITLE (#$NUMBER) by @$AUTHOR'
categories:
- title: '⚡ Breaking Changes'
labels:
- 'breaking-change'
- title: '🌟 New features and non-breaking changes'
labels:
- 'major'
- 'feature'
- title: '🌟 Minor Changes'
labels:
- 'enhancement'
- title: '📜 Documentation updates'
labels:
- 'documentation'
- title: '🐛 Bug and hot fixes'
labels:
- 'bug'
- 'fix'
- title: '🚒 Deprecations'
labels:
- 'deprecated'
exclude-labels:
- 'skip-changelog'
name-template: 'v$RESOLVED_VERSION'
tag-template: 'v$RESOLVED_VERSION'
template: |
## Changes
$CHANGES
## This release was made possible by the following contributors:
$CONTRIBUTORS
15 changes: 15 additions & 0 deletions .github/semantic.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
types:
- feat
- fix
- docs
- style
- refactor
- perf
- test
- build
- ci
- chore
- revert
- improv

titleOnly: true
35 changes: 35 additions & 0 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: "CodeQL"

on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
schedule:
- cron: '27 1 * * 2'

jobs:
analyze:
name: Analyze
runs-on: ubuntu-latest
permissions:
actions: read
contents: read
security-events: write

steps:
- name: Checkout repository
uses: actions/checkout@v2

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v1
with:
languages: javascript
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# queries: ./path/to/local/query, your-org/your-repo/queries@main

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v1
10 changes: 10 additions & 0 deletions .github/workflows/pr-labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: PR Labeler
on: pull_request_target

jobs:
triage:
runs-on: ubuntu-latest
steps:
- uses: actions/labeler@main
with:
repo-token: '${{ secrets.GITHUB_TOKEN }}'
43 changes: 43 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Publish

# RELEASE PROCESS
#
# === Manual ===
#
# 1. Document human readable changes in CHANGES.md
# 2. Bump package version
# 3. Merge into `main` branch
# 4. Go to "Releases" tab and edit the latest draft
# 5. Ensure Git tag matches latest version and that the release notes are appropriate
# 6. Publish the release and monitor CI for success

on:
release:
types: [published]

jobs:
upload:
runs-on: ubuntu-latest
environment: xoi-npm
steps:
- uses: actions/checkout@v2

- uses: actions/setup-node@v2
with:
node-version: '16.x'
registry-url: 'https://registry.npmjs.org'

- name: Ensure new version is also set in CHANGES.md
run: grep --regexp "${{ github.event.release.name }}" CHANGES.md

- run: yarn install --frozen-lockfile

- run: yarn lint

- run: yarn build

- run: yarn test

- run: yarn publish --access public
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
21 changes: 21 additions & 0 deletions .github/workflows/release-drafer.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Release Drafter

on:
push:
branches:
- main

jobs:
update_release_draft:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2

- id: get-version
run: echo "::set-output name=version::$(jq .version -r package.json)"

- uses: release-drafter/release-drafter@v5
with:
version: ${{ steps.get-version.outputs.version }}
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
43 changes: 43 additions & 0 deletions .github/workflows/unit-test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Unit Tests

on:
pull_request:
branches:
- main
push:
branches:
- main

jobs:
build-and-test:
runs-on: ubuntu-latest
strategy:
matrix:
node-version:
- 16.x
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node-version }}
registry-url: 'https://registry.npmjs.org'

- run: yarn install --frozen-lockfile
- run: yarn lint
- run: yarn build
- run: yarn test

coverage:
needs: build-and-test
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: 16.x
registry-url: 'https://registry.npmjs.org'

- run: yarn install --frozen-lockfile
- run: yarn test:coverage

- uses: codecov/codecov-action@v2
107 changes: 107 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
# 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

.DS_Store

6 changes: 6 additions & 0 deletions .lintstagedrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
module.exports = {
'*.js': ['prettier-eslint --write', 'eslint'],
'*.ts': ['prettier-eslint --write', () => 'mocha src/test', 'eslint'],
'*.json': ['prettier --write'],
'*.md': ['prettier --write'],
}
5 changes: 5 additions & 0 deletions .mocharc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module.exports = {
extension: ['ts'],
spec: 'src/test/**/*.test.ts',
require: 'ts-node/register',
}
20 changes: 20 additions & 0 deletions .nycrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"cache": false,
"check-coverage": false,
"extension": [
".ts"
],
"include": [
"src/**/*.ts"
],
"exclude": [
"**/*.test.ts",
"**/*.mock.ts"
],
"sourceMap": true,
"reporter": [
"lcov"
],
"all": true,
"instrument": true
}
10 changes: 10 additions & 0 deletions .prettierrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
module.exports = {
trailingComma: 'es5',
tabWidth: 2,
useTabs: false,
semi: false,
singleQuote: true,
printWidth: 100,
arrowParens: 'always',
proseWrap: 'preserve',
}
Loading

0 comments on commit 49ca8a7

Please sign in to comment.