Skip to content

Commit

Permalink
Merge branch 'develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
arcticicestudio committed Apr 4, 2021
2 parents c202264 + 70b81fc commit e5acea3
Show file tree
Hide file tree
Showing 84 changed files with 1,257 additions and 7,826 deletions.
12 changes: 6 additions & 6 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Copyright (C) 2018-present Arctic Ice Studio <[email protected]>
# Copyright (C) 2018-present Sven Greb <[email protected]>
#
# Project: Styleguide JavaScript
# Repository: https://github.com/arcticicestudio/styleguide-javascript
# License: MIT
# Copyright (c) 2018-present Arctic Ice Studio <[email protected]>
# Copyright (c) 2018-present Sven Greb <[email protected]>
# This source code is licensed under the MIT license found in the LICENSE file.

# Configurations for EditorConfig.
# See https://editorconfig.org/#file-format-details for more details.

# +--------------------+
# + Base Configuration +
Expand Down
13 changes: 6 additions & 7 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
# Copyright (C) 2018-present Arctic Ice Studio <[email protected]>
# Copyright (C) 2018-present Sven Greb <[email protected]>
#
# Project: Styleguide JavaScript
# Repository: https://github.com/arcticicestudio/styleguide-javascript
# License: MIT
# Copyright (c) 2018-present Arctic Ice Studio <[email protected]>
# Copyright (c) 2018-present Sven Greb <[email protected]>
# This source code is licensed under the MIT license found in the LICENSE file.

# Path match pattern to ignore specific files and directories.
# See https://eslint.org/docs/user-guide/configuring/ignoring-code for more details.

build/*
**/node_modules/*
!.eslintrc.js
!.huskyrc.js
!.remarkrc.js
16 changes: 7 additions & 9 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@
/*
* Copyright (C) 2018-present Arctic Ice Studio <[email protected]>
* Copyright (C) 2018-present Sven Greb <[email protected]>
*
* Project: Styleguide JavaScript
* Repository: https://github.com/arcticicestudio/styleguide-javascript
* License: MIT
* Copyright (c) 2018-present Arctic Ice Studio <[email protected]>
* Copyright (c) 2018-present Sven Greb <[email protected]>
* This source code is licensed under the MIT license found in the LICENSE file.
*/

/**
* The ESLint configuration.
* Configurations for ESLint.
*
* @see https://eslint.org/docs/user-guide/configuring
*/
module.exports = {
extends: [
"./packages/@arcticicestudio/eslint-config-base/index.js",
"./packages/@arcticicestudio/eslint-config/prettier.js"
]
"./packages/@arcticicestudio/eslint-config/prettier.js",
],
};
14 changes: 7 additions & 7 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Copyright (C) 2018-present Arctic Ice Studio <[email protected]>
# Copyright (C) 2018-present Sven Greb <[email protected]>
# Copyright (c) 2018-present Arctic Ice Studio <[email protected]>
# Copyright (c) 2018-present Sven Greb <[email protected]>
# This source code is licensed under the MIT license found in the LICENSE file.

# Configuration to define attributes per path.
#
# Project: Styleguide JavaScript
# Repository: https://github.com/arcticicestudio/styleguide-javascript
# License: MIT
# References:
# https://git-scm.com/docs/gitattributes
# https://git-scm.com/book/en/v2/Customizing-Git-Git-Attributes#Keyword-Expansion
# 1. https://git-scm.com/docs/gitattributes
# 2. https://git-scm.com/book/en/v2/Customizing-Git-Git-Attributes#Keyword-Expansion

# Automatically perform line feed (LF) normalization for files detected as text and
# leave all files detected as binary untouched.
Expand Down
14 changes: 9 additions & 5 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# Configuration for the GitHub feature to automatically request reviews from the code owners when a pull request changes any owned files.
# Copyright (c) 2018-present Arctic Ice Studio <[email protected]>
# Copyright (c) 2018-present Sven Greb <[email protected]>
# This source code is licensed under the MIT license found in the LICENSE file.

# Configuration for the GitHub feature to automatically request reviews from the code owners when a pull request
# changes any owned files.
#
# References:
# https://github.com/blog/2392-introducing-code-owners
# https://help.github.com/articles/about-codeowners
# 1. https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners
# 2. https://github.com/blog/2392-introducing-code-owners

# +--------------------+
# + Default Code Owner +
# +--------------------+
* @arcticicestudio
* @svengreb
* @arcticicestudio @svengreb
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<!-- Click on the "Preview" tab to render the instructions in a more readable format -->

> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CONTRIBUTING.md) before filling out this issue template**.
> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/master/CONTRIBUTING.md) before filling out this issue template**.
## [Please follow one of the issue templates](https://github.com/arcticicestudio/styleguide-javascript/issues/new/choose)

To keep the backlog clean and actionable, issues should be opened using [one the provided issue templates](https://github.com/arcticicestudio/styleguide-javascript/issues/new/choose) to help maintainers and the community to understand it, find related reports and to resolve tickets faster.

### Support

If you got a question or need help with any aspect of the project feel free to [join the community](https://spectrum.chat/arcticicestudio) and ensure to read the [project documentations](https://github.com/arcticicestudio/styleguide-javascript).
If you got a question or need help with any aspect of the project feel free to ask and ensure to read the [extensive project documentations](https://arcticicestudio.github.io/styleguide-javascript).

You can also search for already opened and related issue using the search for the [“question“](https://github.com/arcticicestudio/styleguide-javascript/labels/type-question) issue label.
20 changes: 9 additions & 11 deletions .github/ISSUE_TEMPLATE/bugs.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ about: Report a bug that is caused by the code in this repository

<!-- Click on the "Preview" tab to render the instructions in a more readable format -->

> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CONTRIBUTING.md) before filling out this issue template**.
> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/master/CONTRIBUTING.md) before filling out this issue template**.
## Prerequisites

Expand All @@ -14,12 +14,11 @@ This section and the instructions in the sections below are only part of this is
Please do your best to provide as much information as possible and use a clear and descriptive title for your bug report to help maintainers and the community understand and reproduce the behavior, find related reports and to resolve the ticket faster.

- **Ensure the bug has not already been reported by using the [GitHub Issues search](https://github.com/arcticicestudio/styleguide-javascript/issues)** — check if this enhancement has already been suggested. If it has **and the issue is still open**, add your additions as comment to the existing issue instead of opening a new one. If you find a closed issue that seems to be similar to this one, include a link to the original issue in the [metadata head](#metadata-head) section of this issue.
- **Ensure your [contribution belongs to the correct scope](https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CONTRIBUTING.md#contribution-scope).**
- **Ensure the bug is reproducible and has not already been fixed** — use the [latest version](https://github.com/arcticicestudio/styleguide-javascript/releases/latest) and [`develop`](https://github.com/arcticicestudio/styleguide-javascript/tree/develop) branch.
- **Ensure the bug is reproducible and has not already been fixed** — use the [latest version](https://github.com/arcticicestudio/styleguide-javascript/releases/latest) and [`master`](https://github.com/arcticicestudio/styleguide-javascript/tree/master) branch.

## Metadata Head

The metadata head can be added to the top of the issue as [Markdown text quote](https://help.github.com/articles/basic-writing-and-formatting-syntax) containing the the ID of other related issues.
The metadata head can be added to the top of the issue as [Markdown text quote](https://docs.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax) containing the the ID of other related issues.

> Related issues:
Expand All @@ -43,20 +42,19 @@ What actually happens?

## Example

Provide a [MCVE - The Minimal, Complete, and Verifiable Example](https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CONTRIBUTING.md#mcve)
Provide a [MCVE - The Minimal, Complete, and Verifiable Example](https://github.com/arcticicestudio/styleguide-javascript/blob/master/CONTRIBUTING.md#mcve)

**This is a optional section, but it can drastically increase the speed at which this issue can be processed since it takes away the time-consuming reconstruction to reproduce the bug.**
The recommended way is to upload it as [Gist](https://gist.github.com) or new repository to GitHub, but of course you can [attach it to this issue](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests), use any free file hosting service or paste the code in [Markdown code blocks](https://help.github.com/articles/basic-writing-and-formatting-syntax) into this issue.
The recommended way is to upload it as [Gist](https://gist.github.com) or new repository to GitHub, but of course you can [attach it to this issue](https://docs.github.com/en/github/managing-your-work-on-github/file-attachments-on-issues-and-pull-requests), use any free file hosting service or paste the code in [Markdown code blocks](https://docs.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax) into this issue.

## Environment and Versions

- What is the version of „Styleguide JavaScript“ or package you are running?
- Is the problem scoped to the style guide or any of the [provided linter packages](https://github.com/arcticicestudio/styleguide-javascript/tree/develop/packages)?
- What is the version of styleguide-javascript you are using?
- What is the name and the version of your OS?
- Have you tried to reproduce it on different OS environments and if yes is the behavior the same for all?
- If the problem is related to the runtime of the project (e.g. [Node.js](https://nodejs.org), [Go](https://golang.org) or [Java](https://java.com)) please provide the version you're running.
- If the problem is related to the runtime of the project (e.g. [Node.js](https://nodejs.org) or [Go](https://golang.org)) please provide the version you're running.
- Are you using any additional CLI arguments to run the project?
- What is the version of the build tool (e.g. [Yarn](https://yarnpkg.com)/[npm](https://www.npmjs.com), [Go Modules](https://github.com/golang/go/wiki/Modules) or [Gradle](https://gradle.org)) you are running?
- What is the version of the build tool (e.g. [npm](https://www.npmjs.com) or [Yarn](https://yarnpkg.com)) you are running?
- Are you using any additional CLI arguments to start the build tool task/script other than defined by the project?

If you've installed [Node.js](https://nodejs.org) on your system you can run [envinfo](https://www.npmjs.com/package/envinfo) via [npx](https://blog.npmjs.org/post/162869356040/introducing-npx-an-npm-package-runner) which will print environment information that help the the community to better reproduce the bug.
Expand All @@ -70,7 +68,7 @@ Paste output of the command here.
## Stack Trace and Error Messages

```raw
Paste the full stack trace, error messages or the log file here.
Paste the full stack trace, error messages or the logfile here.
```

... or [attach them as files](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests) to this issue.
Expand Down
11 changes: 5 additions & 6 deletions .github/ISSUE_TEMPLATE/enhancement.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ about: Submit an enhancement suggestion for new features or minor improvements t

<!-- Click on the "Preview" tab to render the instructions in a more readable format -->

> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CONTRIBUTING.md) before filling out this issue template**.
> **Please read the [contribution guidelines](https://github.com/arcticicestudio/styleguide-javascript/blob/master/CONTRIBUTING.md) before filling out this issue template**.
## Prerequisites

Expand All @@ -14,12 +14,11 @@ This section and the instructions in the sections below are only part of this is
Please do your best to provide as much information as possible and use a clear and descriptive title for your enhancement suggestion to help maintainers and the community understand and reproduce the behavior, find related reports and to resolve the ticket faster.

- **Ensure the enhancement has not already been reported by using the [GitHub Issues search](https://github.com/arcticicestudio/styleguide-javascript/issues)** — check if this enhancement has already been suggested. If it has **and the issue is still open**, add your additions as comment to the existing issue instead of opening a new one. If you find a closed issue that seems to be similar to this one, include a link to the original issue in the [metadata head](#metadata-head) section of this issue.
- **Ensure your [contribution belongs to the correct scope](https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CONTRIBUTING.md#contribution-scope).**
- **Check if the enhancement has already been implemented** — use the [latest version](https://github.com/arcticicestudio/styleguide-javascript/releases/latest) and [`develop`](https://github.com/arcticicestudio/styleguide-javascript/tree/develop) branch to ensure that the feature or improvement has not already been added.
- **Check if the enhancement has already been implemented** — use the [latest version](https://github.com/arcticicestudio/styleguide-javascript/releases/latest) and [`master`](https://github.com/arcticicestudio/styleguide-javascript/tree/master) branch to ensure that the feature or improvement has not already been added.

## Metadata Head

The metadata head can be added to the top of the issue as [Markdown text quote](https://help.github.com/articles/basic-writing-and-formatting-syntax) containing the ID of other related issues.
The metadata head can be added to the top of the issue as [Markdown text quote](https://docs.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax) containing the ID of other related issues.

> Related issues:
Expand All @@ -41,10 +40,10 @@ If you've considered alternative features or solutions please describe it clearl

## Example

Provide a [MCVE - The Minimal, Complete, and Verifiable Example](https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CONTRIBUTING.md#mcve)
Provide a [MCVE - The Minimal, Complete, and Verifiable Example](https://github.com/arcticicestudio/styleguide-javascript/blob/master/CONTRIBUTING.md#mcve)

**This is a optional section, but it can drastically increase the speed at which this issue can be processed since it takes away the time-consuming reconstruction to reproduce the enhancement.**
The recommended way is to upload it as [Gist](https://gist.github.com) or new repository to GitHub, but of course you can [attach it to this issue](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests), use any free file hosting service or paste the code in [Markdown code blocks](https://help.github.com/articles/basic-writing-and-formatting-syntax) into this issue.
The recommended way is to upload it as [Gist](https://gist.github.com) or new repository to GitHub, but of course you can [attach it to this issue](https://docs.github.com/en/github/managing-your-work-on-github/file-attachments-on-issues-and-pull-requests), use any free file hosting service or paste the code in [Markdown code blocks](https://docs.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax) into this issue.

## Additional Context

Expand Down
Loading

0 comments on commit e5acea3

Please sign in to comment.