@kontent-ai/eslint-config 0.1.2 → 1.0.0

package/.github/CODEOWNERS

@@ -1,4 +1,4 @@
 # Users referenced in this file will automatically be requested as reviewers for PRs that modify the given paths.
 # See https://help.github.com/articles/about-code-owners/
 
-* @kontent-ai/developer-relations
+* @JiriLojda @kontent-ai/developer-relations

package/.github/workflows/release.yml

@@ -7,23 +7,18 @@ jobs:
   publish:
     runs-on: ubuntu-latest
 
-
     steps:
       - uses: actions/checkout@v3
-
       - name: Use Node.js
         uses: actions/setup-node@v3
         with:
           node-version-file: '.nvmrc'
           registry-url: 'https://registry.npmjs.org'
-      - name: Extract version from tag
-        id: get_version
-        uses: battila7/get-version-action@v2
-      - run: npm --no-git-tag-version version ${{ steps.get_version.outputs.version-without-v }}
       - run: npm publish --access=public
+        if: ${{!github.event.release.prerelease}}
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_API_KEY }}
-      - uses: stefanzweifel/git-auto-commit-action@v4
-        with:
-          commit_message: Adjust release version to ${{ steps.get_version.outputs.version-without-v }}
-          branch: ${{ github.event.repository.default_branch }}
+      - run: npm publish --tag prerelease
+        if: ${{github.event.release.prerelease}}
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_API_KEY }}

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Kontent s.r.o.
+Copyright (c) 2023 Kontent s.r.o
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,4 +1,5 @@
 [![Contributors][contributors-shield]][contributors-url]
+[![npm][npm-shield]](https://www.npmjs.com/package/@kontent-ai/eslint-config)
 [![Forks][forks-shield]][forks-url]
 [![Stargazers][stars-shield]][stars-url]
 [![Issues][issues-shield]][issues-url]
@@ -13,27 +14,50 @@ This is the eslint configuration that Kontent.ai uses for its TypeScript package
 
 # Getting Started
 
-Install the package and [extend](https://eslint.org/docs/latest/use/configure/configuration-files#extending-configuration-files) from it your eslint configuration. 
+1. Install the package the eslint configuration.
+
+    ```sh
+    # optionaly install eslint if you don't already have it
+    # npm i --save-dev eslint
+    npm i --save-dev @kontent-ai/eslint-config
+    ```
+
+1. [Extend](https://eslint.org/docs/latest/use/configure/configuration-files#extending-configuration-files) your eslint configuration
+
+    ```jsonc
+    // showcase of .eslintrc.json
+    {
+        // ...
+        "extends": [
+            // ...
+            "@kontent-ai",
+            "@kontent-ai/eslint-config/react"
+        ]
+    }
+    ```
+
+1. Run the lint process based on your project configuration
 
 Available configurations are:
-* kontent-ai (default configuration for any TypeScript file)
-* kontent-ai/react (react specific, extends default)
-* kontent-ai/jest (jest specific, extends default)
+* `@kontent-ai` (default configuration for any TypeScript file)
+* `@kontent-ai/eslint-config/react` (react specific, extends default)
+* `@kontent-ai/eslint-config/jest` (jest specific, extends default)
 
 # License
 
 Distributed under the MIT License. See [`LICENSE.md`](./LICENSE.md) for more information.
 
 
-[contributors-shield]: https://img.shields.io/github/contributors/JiriLojda/eslint-config-kontent-ai.svg?style=for-the-badge
-[contributors-url]: https://github.com/JiriLojda/eslint-config-kontent-ai/graphs/contributors
-[forks-shield]: https://img.shields.io/github/forks/JiriLojda/eslint-config-kontent-ai.svg?style=for-the-badge
-[forks-url]: https://github.com/JiriLojda/eslint-config-kontent-ai/network/members
-[stars-shield]: https://img.shields.io/github/stars/JiriLojda/eslint-config-kontent-ai.svg?style=for-the-badge
-[stars-url]: https://github.com/JiriLojda/eslint-config-kontent-ai/stargazers
-[issues-shield]: https://img.shields.io/github/issues/JiriLojda/eslint-config-kontent-ai.svg?style=for-the-badge
-[issues-url]:https://github.com/JiriLojda/eslint-config-kontent-ai/issues
-[license-shield]: https://img.shields.io/github/license/JiriLojda/eslint-config-kontent-ai.svg?style=for-the-badge
-[license-url]:https://github.com/JiriLojda/eslint-config-kontent-ai/blob/master/LICENSE.md
+[contributors-shield]: https://img.shields.io/github/contributors/kontent-ai/eslint-config.svg?style=for-the-badge
+[contributors-url]: https://github.com/kontent-ai/eslint-config/graphs/contributors
+[npm-shield]: https://img.shields.io/badge/NPM-%23CB3837.svg?style=for-the-badge&logo=npm&logoColor=white
+[forks-shield]: https://img.shields.io/github/forks/kontent-ai/eslint-config.svg?style=for-the-badge
+[forks-url]: https://github.com/kontent-ai/eslint-config/network/members
+[stars-shield]: https://img.shields.io/github/stars/kontent-ai/eslint-config.svg?style=for-the-badge
+[stars-url]: https://github.com/kontent-ai/eslint-config/stargazers
+[issues-shield]: https://img.shields.io/github/issues/kontent-ai/eslint-config.svg?style=for-the-badge
+[issues-url]:https://github.com/kontent-ai/eslint-config/issues
+[license-shield]: https://img.shields.io/github/license/kontent-ai/eslint-config.svg?style=for-the-badge
+[license-url]:https://github.com/kontent-ai/eslint-config/blob/master/LICENSE.md
 [discord-shield]: https://img.shields.io/discord/821885171984891914?color=%237289DA&label=Kontent.ai%20Discord&logo=discord&style=for-the-badge
 [discord-url]: https://discord.com/invite/SKCxwPtevJ

package/jest.js

@@ -4,7 +4,7 @@ module.exports = {
   ],
 
   extends: [
-    "kontent-ai",
+    "@kontent-ai",
     "plugin:jest/recommended",
     "plugin:jest/style",
   ],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kontent-ai/eslint-config",
-  "version": "0.1.2",
+  "version": "1.0.0",
   "description": "Eslint configuration used for packages in Kontent.ai",
   "main": "index.js",
   "private": false,
@@ -8,15 +8,15 @@
   "author": "Jiri Lojda",
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "@typescript-eslint/parser": "^5.5.0"
+    "@typescript-eslint/parser": "^6.19.0"
   },
   "peerDependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.0.0",
+    "@typescript-eslint/eslint-plugin": "^6.19.0",
     "eslint": "^8.0.0",
-    "eslint-plugin-jest": "^25.0.0",
-    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-import": "^2.29.0",
+    "eslint-plugin-jest": "^27.0.0",
     "eslint-plugin-react": "^7.0.0",
     "eslint-plugin-react-hooks": "^4.0.0",
-    "eslint-plugin-simple-import-sort": "^9.0.0"
+    "eslint-plugin-simple-import-sort": "^10.0.0"
   }
 }

package/react.js

@@ -5,7 +5,7 @@ module.exports = {
   ],
 
   extends: [
-    "kontent-ai",
+    "@kontent-ai",
   ],
 
   rules: {

package/CODE_OF_CONDUCT.md

@@ -1,46 +0,0 @@
-# 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, 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 at devrel@kontent.ai. The project team will review and investigate all complaints, and will respond in a way that it deems 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://contributor-covenant.org/version/1/4][version]
-
-[homepage]: https://contributor-covenant.org
-[version]: https://contributor-covenant.org/version/1/4/

package/CONTRIBUTING.md

@@ -1,68 +0,0 @@
-# Ways to contribute 
-<img align="right" width="100" height="100" src="https://i.imgur.com/PYTV0jP.png">
-
-There are many different ways in which you can contribute. One of the easiest ways is simply to use our software and provide us with your feedback through the right channel. You can also help us improve the open-source projects by submitting pull requests with code and documentation changes.
-
-## Where to get support
-Please note that **level of provided support is always determined by the [LICENSE](LICENSE.md)** of a given open-source project. Also, always make sure you use the **[latest version](../../releases)** of any given OS project. We can't provide any help for older versions. We don't want to make things complicated so we try to take the same approach in all our repositories. 
-
-### I found a bug in a Kontent.ai open-source project
-<img align="right" width="100" height="100" src="https://i.imgur.com/TYIQdpv.png">
-
-Sorry to hear that. Just log a new [GitHub issue](../../issues) and someone will take a look at it. Remember, the more information you provide, the easier it will be to fix the issue. If you feel like it, you can also fix the bug on your own and submit a new pull request.
-
-### I need help with using the projects and/or coding
-<img align="right" width="100" height="100" src="https://cdn.sstatic.net/Sites/stackoverflow/company/img/logos/so/so-icon.svg">
-
-To get help with coding and structuring your projects, use [StackOverflow](https://stackoverflow.com/) and tag your questions with [`kontent-ai`](https://stackoverflow.com/questions/tagged/kontent-ai) tag.
-
-Our team members and the community monitor these channels on a regular basis.
-
-### I want to report a security bug
-<img align="right" width="100" height="100" src="https://i.imgur.com/z82nnJB.png">
-
-Security issues and bugs should be reported privately, via email, to Kontent.ai Developer Relations Team devrel@kontent.ai. You should receive a response within 24 hours. If for some reason you do not, send us a follow up email to ensure we received your original message.
-
-
-### I have an idea for a new feature (or feedback on existing functionality)
-<img align="right" width="100" height="100" src="https://i.imgur.com/rUFkyPy.png">
-
-Everybody loves new features! You can submit a new [feature request](../../issues) or you can code it on your own and [send us a pull request](#submitting-pull-requests). In either case, don't forget to mention what's the use case and what's the expected output.
-
-
-## Submitting pull requests
-<img align="right" width="100" height="100" src="https://i.imgur.com/aSeiliy.png">
-
-Unless you're fixing a typo, it's usually a good idea to discuss the feature before you submit a pull request with code changes, so let's start with submitting a new [GitHub issue](../../issues) and discussing the whether it fits the vision of a given project.
-You might also read these two blogs posts on contributing code: [Open Source Contribution Etiquette](http://tirania.org/blog/archive/2010/Dec-31.html) by Miguel de Icaza and [Don't "Push" Your Pull Requests](https://www.igvita.com/2011/12/19/dont-push-your-pull-requests/) by Ilya Grigorik. Note that all code submissions will be rigorously reviewed and tested by Kontent.ai maintainer teams, and only those that meet an high bar for both quality and design/roadmap appropriateness will be merged into the source.
-
-
-### Example - process of contribution
-If not stated otherwise, we use [feature branch workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow). 
-
-To start with coding, fork the repository you want to contribute to, create a new branch, and start coding. Once the functionality is [done](#Definition-of-Done), you can submit a [pull request](https://help.github.com/articles/about-pull-requests/). 
-
-### Definition of Done
-<img align="right" width="100" height="100" src="https://i.imgur.com/g82Ohdv.png">
-
-- New/fixed code is covered with tests
-- CI can build the code
-- All tests are pass
-- New version number follows [semantic versioning](https://semver.org/)
-- Coding style (spaces, indentation) is in line with the rest of the code in a given repository
-- Documentation is updated (e.g. code examples in README, Wiki pages, etc.)
-- All `public` members are documented (using XML doc, phpdoc, etc.)
-- Code doesn't contain any secrets (private keys, etc.)
-- Commit messages are clear. Please read these articles: [Writing good commit messages](https://github.com/erlang/otp/wiki/Writing-good-commit-messages), [A Note About Git Commit Messages](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html), [On commit messages](https://who-t.blogspot.com/2009/12/on-commit-messages.html)
-
-
-### Feedback
-<img align="right" width="100" height="100" src="https://i.imgur.com/ZQfNzJJ.png">
-
-Your pull request will now go through extensive checks by the subject matter experts on our team. Please be patient. Update your pull request according to feedback until it is approved by one of Kontent.ai maintainers. After that, one of our team members may adjust the branch you merge into based on the expected release schedule.
-
-
-## Code of Conduct
-<img align="right" width="100" height="100" src="https://i.imgur.com/cObdKQy.png">
-
-The Kontent.ai team is committed to fostering a welcoming community, therefore this project has adopted the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). If you have any additional questions or comments, you can contact us directly at devrel@kontent.ai.