diff --git a/.babelrc b/.babelrc new file mode 100644 index 0000000..8818b8f --- /dev/null +++ b/.babelrc @@ -0,0 +1,6 @@ +{ + "presets": [ + "@babel/env", + "@babel/preset-typescript" + ] +} diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 829a74c..bd73489 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,4 +1,4 @@ -name: Release +name: Release Package on: push: @@ -7,7 +7,7 @@ on: jobs: release: - name: Release + name: Release Package runs-on: ubuntu-20.04 steps: - name: Checkout 'main' Branch @@ -24,11 +24,11 @@ jobs: run: npm install --global yarn - name: Configure CI run: yarn install --frozen-lockfile - - name: Run Build + - name: Build run: yarn build - - name: Run Tests + - name: Test run: yarn test - - name: Release Package + - name: Publish run: yarn run semantic-release env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.gitignore b/.gitignore index fed88be..5315b25 100644 --- a/.gitignore +++ b/.gitignore @@ -1,11 +1,12 @@ # Dependencies -node_modules +node_modules/ -# Distributed version -dist +# Distribution directory +dist/ -# Logs +# Log files *.log -# MacOS +# Operating System .DS_Store +Thumbs.db diff --git a/.npmignore b/.npmignore index aad2135..92f140d 100644 --- a/.npmignore +++ b/.npmignore @@ -2,14 +2,8 @@ *.config.* .tsconfig.* -# Git -.gitignore - -# Github workflows -.github - -# Husky -.husky +# Hidden directories +.*/** # Ignore files .*ignore @@ -18,7 +12,7 @@ .*rc # Source directory -src +src/ -# Types -types +# Types directory +types/ diff --git a/.prettierignore b/.prettierignore index 8fb6ee5..2a27ed1 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,6 +1,12 @@ - # Dependencies -node_modules +node_modules/ + +# Distribution directory +dist/ + +# Hidden directories +.*/** +!.github/** # Ignore files .*ignore @@ -8,17 +14,15 @@ node_modules # License LICENSE -# MacOS +# Log files +*.log + +# Operating System .DS_Store +Thumbs.db # Package files yarn.lock # Run Command files .*rc - -# Files within hidden folders -.*/** - -# Distribution folder -dist diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e335ffd --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,92 @@ +# Contributing + +When contributing to this repository, please first discuss the change you wish to make via issue, +email, or any other method with the owners of this repository before making a change. + +Please note we have a code of conduct, please follow it in all your interactions with the project. + +## Pull Request Process + +1. Ensure any install or build dependencies are removed before the end of the layer when doing a + build. +2. Update the README.md with details of changes to the interface, this includes new environment + variables, exposed ports, useful file locations and container parameters. +3. Increase the version numbers in any examples files and the README.md to the new version that this + Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). +4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you + do not have permission to do that, you may request the second reviewer to merge it for you. + +## Code of Conduct + +### Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +### Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +- The use of sexualized language or imagery and unwelcome sexual attention or + advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic + address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting + +### Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +### Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +### Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +### Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/babel.config.json b/babel.config.json deleted file mode 100644 index ded10f9..0000000 --- a/babel.config.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "presets": ["@babel/env", "@babel/preset-typescript"] -} diff --git a/package.json b/package.json index 018d251..e1072bc 100644 --- a/package.json +++ b/package.json @@ -9,8 +9,7 @@ "author": "DanMad", "main": "dist/index.js", "scripts": { - "build": "rm -rf dist && webpack", - "sort-package": "sort-package-json", + "build": "rm -rf dist && webpack --env production", "test": "jest", "test:coverage": "jest --coverage --colors", "test:watch": "jest --watch" diff --git a/webpack.config.js b/webpack.config.js index e662ba8..630354e 100644 --- a/webpack.config.js +++ b/webpack.config.js @@ -1,5 +1,4 @@ const path = require('path'); -const babel = require('./babel.config.json'); module.exports = { entry: './src/index', @@ -13,7 +12,7 @@ module.exports = { { loader: 'babel-loader', options: { - presets: babel.presets, + presets: ['@babel/env', '@babel/preset-typescript'], }, }, ],