Skip to content

Commit

Permalink
style: lint fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
prisis committed Oct 9, 2023
1 parent f3173c6 commit 3746d63
Show file tree
Hide file tree
Showing 7 changed files with 56 additions and 56 deletions.
1 change: 1 addition & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ vitest.config.ts
_meta.*.json
.eslintrc.cjs
commitlint.config.cjs
.secretlintrc.cjs

coverage
__fixtures__
Expand Down
30 changes: 15 additions & 15 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible 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.
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible 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.

Check failure on line 5 in .github/CODE_OF_CONDUCT.md

View workflow job for this annotation

GitHub Actions / Lint (markdown)

[sex] Reconsider using `sex`, it may be profane

Check failure on line 5 in .github/CODE_OF_CONDUCT.md

View workflow job for this annotation

GitHub Actions / Lint (markdown)

[sexual] Reconsider using `sexual`, it may be profane

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

Expand All @@ -14,15 +14,15 @@ Examples of behavior that contributes to a positive environment for our communit
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback

Check failure on line 15 in .github/CODE_OF_CONDUCT.md

View workflow job for this annotation

GitHub Actions / Lint (markdown)

"gracefully" can weaken meaning
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community
- Focusing on what is best not for as individuals, but for the overall community

Check failure on line 17 in .github/CODE_OF_CONDUCT.md

View workflow job for this annotation

GitHub Actions / Lint (markdown)

"overall" is wordy or unneeded

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or

Check failure on line 21 in .github/CODE_OF_CONDUCT.md

View workflow job for this annotation

GitHub Actions / Lint (markdown)

[sexual] Reconsider using `sexual`, it may be profane
advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks

Check failure on line 23 in .github/CODE_OF_CONDUCT.md

View workflow job for this annotation

GitHub Actions / Lint (markdown)

[attacks] Be careful with `attacks`, it’s profane in some cases
- Public or private harassment
- Publishing others' private information, such as a physical or email
- Publishing others private information, such as a physical or email
address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting
Expand All @@ -35,7 +35,7 @@ Community leaders have the right and responsibility to remove, edit, or reject c

## Scope

This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.

## Enforcement

Expand All @@ -49,36 +49,36 @@ Community leaders will follow these Community Impact Guidelines in determining t

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
**Community Impact:** Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
**Consequence:** A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of actions.
**Community Impact:** A violation through a single incident or series of actions.

**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
**Consequence:** A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
**Community Impact:** A serious violation of community standards, including sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
**Consequence:** A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
**Community Impact:** Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the community.
**Consequence:** A permanent ban from any sort of public interaction within the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
available at https://www.contributor-covenant.org/version/2/0/code_of_conduct/.

Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
Community Impact Guidelines were inspired by [Mozillas code of conduct enforcement ladder](https://github.com/mozilla/inclusion).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
https://www.contributor-covenant.org/faq/. Translations are available at https://www.contributor-covenant.org/translations/.
46 changes: 23 additions & 23 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,15 @@ The following is a set of guidelines for contributing. Since these are mostly gu

### Code of Conduct

This project and everyone participating in it is governed by [the repository's code of conduct](../CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to dev@joshuahemphill.com.
This project and everyone participating in it’s governed by [the repositorys code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to dev@joshuahemphill.com.

## How Can I Contribute?

### Reporting bugs

This section guides you through submitting a bug report for vite-plugin-favicon. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻, and find related reports 🔎.

Before creating bug reports, please check [this list](#before-submitting-a-bug-report) as you might find out that you don't need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). Fill out [the required template](https://github.com/josh-hemphill/vite-plugin-favicon/.github/.github/ISSUE_TEMPLATE/bug_report.md), the information it asks for helps us resolve issues faster.
Before creating bug reports, please check [this list](#before-submitting-a-bug-report) as you find out that you dont need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). Fill out [the required template](https://github.com/josh-hemphill/vite-plugin-favicon/.github/.github/ISSUE_TEMPLATE/bug_report.md), the information it asks for helps resolve issues faster.

#### Before Submitting A Bug Report

Expand All @@ -46,49 +46,49 @@ Before creating bug reports, please check [this list](#before-submitting-a-bug-r
Explain the problem and include additional details to help maintainers reproduce the problem:

- **Use a clear and descriptive title** for the issue to identify the problem.
- **Describe the exact steps which reproduce the problem** in as many details as possible. For example, start by explaining how you invoked vite-plugin-favicon, e.g. which function exactly you used, or how you imported it otherwise. When listing steps, **don't just say what you did, but explain how you did it**. For example, if you used an internal function, don't just say you used it, provide what data you passed it, and if/how it was passed back into other vite-plugin-favicon functions.
- **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
- **Describe the exact steps which reproduce the problem** in as many details as possible. For example, start by explaining how you invoked vite-plugin-favicon, e.g. which function exactly you used, or how you imported it otherwise. When listing steps, **don’t say what you did, but explain how you did it**. For example, if you used an internal function, don’t say you used it, provide what data you passed it, and if/how it was passed back into other vite-plugin-favicon functions.
- **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If youre providing snippets in the issue, use [Markdown code blocks](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github#multiple-lines).
- **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
- **Explain which behavior you expected to see instead and why.**
- **If you're reporting that vite-plugin-favicon errored out**, provide the whole stack trace in the issue in a [code block](https://help.github.com/articles/markdown-basics/#multiple-lines), a [file attachment](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests/), or put it in a [gist](https://gist.github.com/) and provide link to that gist.
- **If youre reporting that vite-plugin-favicon errored out**, provide the whole stack trace in the issue in a [code block](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github#multiple-lines), a [file attachment](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/attaching-files), or put it in a [gist](https://gist.github.com/starred) and provide link to that gist.
- **If the problem is related to performance or memory**, include a benchmark link with your report.
- **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below.
- **If the problem wasnt triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below.

Provide more context by answering these questions:

- **Can you reproduce the problem in [a sandbox](https://codepen.io)?**
- **Did the problem start happening recently** or was this always a problem?
- If the problem started happening recently, **can you reproduce the problem in an older version?** What's the most recent version in which the problem doesn't happen? You can download older versions from NPM or Deno.
- If the problem started happening recently, **can you reproduce the problem in an older version?** Whats the most recent version in which the problem doesnt happen? You can download older versions from NPM or Deno.
- **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.

Include details about your configuration and environment:

- **Which version are you using?** You can get the exact version by looking in your `package.json` or in your Deno import.
- **What's the name and version of the OS you're using**?
- **Whats the name and version of the OS youre using**?
- **Which other packages do you have installed?**

### Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for vite-plugin-favicon, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion :pencil: and find related suggestions :mag_right:.

Before creating enhancement suggestions, please check [this list](#before-submitting-an-enhancement-suggestion) as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). Fill in [the template](https://github.com/josh-hemphill/vite-plugin-favicon/.github/blob/master/.github/ISSUE_TEMPLATE/feature_request.md), including the steps that you imagine you would take if the feature you're requesting existed.
Before creating enhancement suggestions, please check [this list](#before-submitting-an-enhancement-suggestion) as you find out that you dont need to create one. When you are creating an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). Fill in [the template](https://github.com/josh-hemphill/vite-plugin-favicon/.github/blob/master/.github/ISSUE_TEMPLATE/feature_request.md), including the steps that you imagine you would take if the feature youre requesting existed.

#### Before Submitting An Enhancement Suggestion

- **Perform** a [cursory search](https://github.com/issues?utf8=✓&q=is%3Aissue+repo%3Ajosh-hemphill/vite-plugin-favicon+label%3Afeature) to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.

#### How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue on the repository and provide the following information:
Enhancement suggestions are tracked as [GitHub issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues). Create an issue on the repository and provide the following information:

- **Use a clear and descriptive title** for the issue to identify the suggestion.
- **Provide a step-by-step description of the suggested enhancement** in as many details as possible.
- **Provide specific examples to demonstrate the steps**. Include copy/pasteable snippets which you use in those examples, as [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
- **Provide specific examples to demonstrate the steps**. Include copy/pasteable snippets which you use in those examples, as [Markdown code blocks](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github#multiple-lines).
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why.
- **Explain why this enhancement would be useful** to most users and isn't something that can or should be implemented as a separate package.
- **List some other places this exists.**
- **Explain why this enhancement would be useful** to most users and isnt something that can or should be implemented as a separate package.
- **List other places this exists.**
- **Which version are you using?** You can get the exact version by looking in your `package.json` or in your Deno import.
- **Specify the name and version of the platform you're using.**
- **Specify the name and version of the platform youre using.**

### Your First Code Contribution

Expand All @@ -108,16 +108,16 @@ For instructions on how to setup and run development, see the following [Develop

The process described here has several goals:

- Maintain vite-plugin-favicon's quality
- Maintain vite-plugin-favicons quality
- Fix problems that are important to users
- Engage the community in working toward the best possible vite-plugin-favicon
- Enable a sustainable system for vite-plugin-favicon's maintainers to review contributions
- Enable a sustainable system for vite-plugin-favicons maintainers to review contributions

Please follow these steps to have your contribution considered by the maintainers:

1. Follow all instructions in [the template](PULL_REQUEST_TEMPLATE.md)
2. Follow the [styleguides](#styleguides)
3. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/)
3. After you submit your pull request, verify that all [status checks](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)
are passing <details><summary>What if the status checks are failing?</summary>
If a status check is failing,
and you believe that the failure is unrelated to your change,
Expand Down Expand Up @@ -162,8 +162,8 @@ export default ClassName;

### Specs Styleguide

- Include thoughtfully-worded, well-structured
[Jest](https://jestjs.io/) tests next to their dependant modules.
- Include thoughtfully worded, well-structured
[Jest](https://jestjs.io/) tests next to their dependent modules.
- Include integration, build, and platform tests under the `test/` directory.
- Treat `describe` as a noun or situation.
- Treat `it` as a statement about state or how an operation changes state.
Expand All @@ -185,7 +185,7 @@ describe("a dog", () => {

### Documentation Styleguide

- Use [Markdown](https://daringfireball.net/projects/markdown).
- Use [Markdown](https://daringfireball.net/projects/markdown/).
- Markdown is linted with
[MarkdownLint](https://github.com/DavidAnson/markdownlint-cli2)
in builds and in VsCode with
Expand All @@ -199,10 +199,10 @@ describe("a dog", () => {
### What should I know before making PRs for core changes?

If you want to contribute to the core source code,
the best way to get a feal for how the internals work,
the best get a feal for how the internals work,
is to read over the jest tests that are in the same `src/lib` folder.
Many of the internals are also exposed via named exports,
so you can play around with individual components if you feel it would be helpful.

It's also helpful to be familiar with regex and parsers,
as well as some idea of what's available when keeping the code platform-agnostic.
Its also helpful to be familiar with regex and parsers,
as well as idea of whats available when keeping the code platform-agnostic.
Loading

0 comments on commit 3746d63

Please sign in to comment.