feat: initial commit

Author: NickDJM

.commitlintrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["@commitlint/config-conventional"],
+};

.eslintrc.js

@@ -0,0 +1,19 @@
+module.exports = {
+  env: {
+    commonjs: true,
+    es6: true,
+    node: true,
+  },
+  extends: ["airbnb", "plugin:prettier/recommended"],
+  plugins: ["prettier"],
+  globals: {
+    Atomics: "readonly",
+    SharedArrayBuffer: "readonly",
+  },
+  parserOptions: {
+    ecmaVersion: 2018,
+  },
+  rules: {
+    "prettier/prettier": "error",
+  },
+};

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# Contributor Covenant 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, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, 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 at [email protected]. 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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

.github/COMMIT_CONVENTION.md

@@ -0,0 +1,17 @@
+# Git Commit Convention
+
+This project uses the conventional commit standard, which means your commits should follow a basic template of:
+
+> \<type>[optional scope]: \<description>
+>
+> [optional body]
+>
+> [optional footer(s)]
+
+For more detailed information about available types, scopes, breaking changes, etc. please see the [official documentation](https://www.conventionalcommits.org/en/v1.0.0/).
+
+This project also provides a command to assist you in formatting commit messages using [commitizen](https://commitizen.github.io/cz-cli/):
+
+```shell
+npm run commit
+```

.github/CONTRIBUTING.md

@@ -0,0 +1,89 @@
+# Contributing to eslint-plugin-drupal-contrib
+
+Whether you want to add a feature or simply report a bug or issue, please have a quick read through these guidelines before contributing.
+
+## Developed with Github
+
+We use github to host code, to track issues and feature requests, as well as accept pull requests. All other forms of communication with maintainers is not considered "official".
+
+## [Github Flow](https://guides.github.com/introduction/flow/index.html) is the Way to Go
+
+All code changes happen through pull requests.
+
+Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
+
+1. Fork the repo and create your branch from dev.
+2. Link your pull request to any relavent open issues.
+3. If you've added or changed functionality, update the documentation.
+4. Make sure your code functions. Write a test if you have to!
+5. Make sure your code lints.
+6. Issue the pull request!
+
+## Any contribution you make will be under the ISC License
+
+In short, when you submit code changes, your submissions are understood to be under the same ISC License that covers the project. Feel free to contact the maintainers if that's a concern.
+
+## Report bugs using Github's [issues](https://github.com/coldfrontlabs/eslint-plugin-drupal-contrib/issues)
+
+We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/coldfrontlabs/eslint-plugin-drupal-contrib/issues/new).
+
+## Write bug reports with detail, background, and sample code
+
+**Great Bug Reports** tend to have:
+
+- A quick summary and/or background
+- Steps to reproduce
+  - Be specific!
+  - Give sample code if you can
+- What you expected would happen
+- What actually happens
+- Notes
+  - why you think this might be happening
+  - stuff you tried that didn't work
+
+Everybody loves a thorough bug report!
+
+## Keep Your Code Consistent
+
+- Run `npm install` to ensure you have all the tools needed.
+- Use the coding standards provided.
+
+This project follows a set of coding standards combining [Airbnb](https://github.com/airbnb/javascript) and [Prettier](https://prettier.io/).
+
+To check your code, you can use [ESLint](https://eslint.org/) with the provided script:
+
+```shell
+npm run lint
+```
+
+You can also fix some violations automatically using:
+
+```shell
+npm run fix
+```
+
+Code that does not follow the linting standards _will not_ be merged.
+
+## Commit Guidelines
+
+This project uses the conventional commit standard, which means your commits should follow a basic template of:
+
+> \<type>[optional scope]: \<description>
+>
+> [optional body]
+>
+> [optional footer(s)]
+
+For more detailed information about available types, scopes, breaking changes, etc. please see the [official documentation](https://www.conventionalcommits.org/en/v1.0.0/).
+
+This project also provides a command to assist you in formatting commit messages using [commitizen](https://commitizen.github.io/cz-cli/):
+
+```shell
+npm run commit
+```
+
+Commits that do not follow this format _will not_ be merged.
+
+## References
+
+This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: 'Bug: [Brief Description]'
+labels: bug
+assignees: ''
+
+---
+
+## Summary
+
+*What is the issue you are experiencing?*
+
+## Steps
+
+*What are the steps to reproduce this issue?*
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+## Expected Behaviour
+
+*What is the expected behaviour?*
+
+## Screenshots
+
+*If applicable, add screenshots to help explain your problem.*
+
+## Additional context
+
+*Is there anything else that would give context about the problem?*

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: 'Feat: [Brief Description]'
+labels: enhancement
+assignees: ''
+
+---
+
+## Related Issues
+
+*Is your feature request related to a problem? Please describe.*
+
+*A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]*
+
+## Solution
+*Describe the solution you'd like*
+
+## Alternatives
+*Describe alternatives you've considered*

.github/pull_request_template.md

@@ -0,0 +1,7 @@
+## Description
+
+*Why are you making this pull request?*
+
+## Related Issues
+
+*Please provide links to any related issues.*

.gitignore

@@ -0,0 +1,8 @@
+# Mac file
+.DS_Store
+
+# Auto-generated directories.
+**/node_modules/*
+
+# Lock files.
+package-lock.json

.huskyrc.js

@@ -0,0 +1,11 @@
+const tasks = list => list.join(" && ");
+
+module.exports = {
+  hooks: {
+    "pre-commit": tasks([
+      "echo committing as $(git config user.name)",
+      "npm run lint",
+    ]),
+    "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
+  },
+};