@inclusive-design/eslint-config 0.1.0

package/.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = tab
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.yml]
+indent_style = space
+indent_size = 2

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,45 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+---
+
+## Describe the bug
+
+A clear and concise description of what the bug is.
+
+## To Reproduce
+
+Steps to reproduce the behavior:
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+## Expected behavior
+
+A clear and concise description of what you expected to happen.
+
+## Screenshots
+
+If applicable, add screenshots to help explain your problem.
+
+## Desktop (please complete the following information):
+
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
+
+## Smartphone (please complete the following information):
+
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS8.1]
+- Browser [e.g. stock browser, safari]
+- Version [e.g. 22]
+
+## Additional context
+
+Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+---
+
+## 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 [...]
+
+## Describe the solution you'd like
+
+A clear and concise description of what you want to happen.
+
+## Describe alternatives you've considered
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+## Additional context
+
+Add any other context or screenshots about the feature request here.

package/.github/code_of_conduct.md

@@ -0,0 +1,130 @@
+
+# Contributor Covenant Code of Conduct
+
+## 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 pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* 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
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* 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
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## 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.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[idrc@ocadu.ca](mailto:idrc@ocadu.ca).
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**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.
+
+### 2. Warning
+
+**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.
+
+### 3. Temporary Ban
+
+**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.
+
+### 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.
+
+**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](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[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](https://www.contributor-covenant.org/faq). Translations are available at
+[https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).

package/.github/pull_request_template.md

@@ -0,0 +1,25 @@
+<!-- markdownlint-disable MD041 -->
+
+* [ ] This pull request has been tested by running `npm run test` without errors
+* [ ] This pull request has been built by running `npm run build` without errors
+* [ ] This isn't a duplicate of an existing pull request
+
+## Description
+
+<!-- Description of the pull request -->
+
+## Steps to test
+
+1. <!-- First step -->
+2. <!-- Second step -->
+3. <!-- and so on... -->
+
+**Expected behavior:** <!-- What should happen -->
+
+## Additional information
+
+<!-- Please provide any additional information that can help us review your contribution. -->
+
+## Related issues
+
+<!-- If this pull request resolves an issue, please indicate the issue number here, e.g. 'Resolves #42' -->

package/.github/workflows/lint-and-test.yml

@@ -0,0 +1,11 @@
+name: Lint and test
+
+on:
+  push:
+    branches: [dev, main]
+  pull_request:
+    branches: [dev, main]
+
+jobs:
+  lint-and-test:
+    uses: inclusive-design/workflows/.github/workflows/node-lint-and-test.yml@main

package/.github/workflows/merge-release.yml

@@ -0,0 +1,89 @@
+name: Merge release
+
+on:
+  release:
+    types: [released]
+  workflow_dispatch:
+    inputs:
+      branch:
+        description: "Branch to merge into"
+        required: false
+        type: string
+        default: main
+      tag:
+        description: "Tag to merge"
+        required: true
+        type: string
+
+jobs:
+  merge-release:
+    timeout-minutes: 5
+    permissions:
+      contents: write
+    strategy:
+      fail-fast: true
+      matrix:
+        os: ["ubuntu-latest"]
+    runs-on: ${{ matrix.os }}
+
+    name: Merge tag
+
+    steps:
+      - uses: actions/create-github-app-token@v2
+        id: app-token
+        with:
+          app-id: ${{ vars.GHA_APP_ID }}
+          private-key: ${{ secrets.GHA_PRIVATE_KEY }}
+
+      - name: Determine branch
+        run: |
+          echo 'BRANCH='${{ inputs.branch || 'main' }} >> $GITHUB_ENV
+
+      - name: Checkout "${{ env.BRANCH }}" branch locally
+        uses: actions/checkout@v5
+        with:
+          ref: ${{ env.BRANCH }}
+          fetch-tags: true
+          fetch-depth: 0
+          token: ${{ steps.app-token.outputs.token }}
+
+      - name: Get GitHub App User ID
+        if: ${{ github.event_name == 'release' }}
+        id: get-user-id
+        run: echo "user-id=$(gh api "/users/${{ steps.app-token.outputs.app-slug }}[bot]" --jq .id)" >> "$GITHUB_OUTPUT"
+        env:
+          GH_TOKEN: ${{ steps.app-token.outputs.token }}
+
+      - name: Update values for git user config (release)
+        if: ${{ github.event_name == 'release' }}
+        run: |
+          echo "GIT_USER_NAME=${{ steps.app-token.outputs.app-slug }}[bot]" >> $GITHUB_ENV
+          echo "GIT_USER_EMAIL=${{ steps.get-user-id.outputs.user-id }}+${{ steps.app-token.outputs.app-slug }}[bot]@users.noreply.github.com" >> $GITHUB_ENV
+
+      - name: Update values for git user config (workflow_dispatch)
+        if: ${{ github.event_name == 'workflow_dispatch' }}
+        run: |
+          # fetch user info
+          user=$(gh api \
+            -H "Accept: application/vnd.github+json" \
+            -H "X-GitHub-Api-Version: 2022-11-28" \
+            /user/$ACCOUNT_ID )
+
+          # get user's name and email
+          # email will be set to null if it is private
+          name=$(echo $user | jq '.name')
+          email=$(echo $user | jq '.email')
+
+          # store in environment variables to use for setting up git user
+          echo "GIT_USER_NAME=$name" >> $GITHUB_ENV
+          echo "GIT_USER_EMAIL=$email" >> $GITHUB_ENV
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          ACCOUNT_ID: ${{ github.actor_id }}
+
+      - name: Merge tag to "${{ env.BRANCH }}" branch
+        run: |
+          git config --local user.email "$GIT_USER_EMAIL"
+          git config --local user.name "$GIT_USER_NAME"
+          git merge ${{ inputs.tag || github.event.release.tag_name }}
+          git push

package/.github/workflows/release.yml

@@ -0,0 +1,17 @@
+name: Release
+
+on:
+  push:
+    branches: [dev]
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release:
+    uses: inclusive-design/workflows/.github/workflows/release-please.yml@main
+    with:
+      GHA_APP_ID: ${{ vars.GHA_APP_ID }}
+    secrets:
+      GHA_PRIVATE_KEY: ${{ secrets.GHA_PRIVATE_KEY }}

package/.github/workflows/sync-branches.yml

@@ -0,0 +1,10 @@
+name: Sync branches
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  sync-branches:
+    uses: inclusive-design/workflows/.github/workflows/sync-branches.yml@main
+    secrets: inherit

package/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+	".": "0.1.0"
+}

package/.zed/settings.json

@@ -0,0 +1,10 @@
+{
+	"languages": {
+		"JavaScript": {
+			"formatter": [],
+			"code_actions_on_format": {
+				"source.fixAll.eslint": true
+			}
+		}
+	}
+}

package/eslint.config.js

@@ -0,0 +1 @@
+export {default} from './index.js';

package/index.js

@@ -0,0 +1,10 @@
+import {defineConfig} from 'eslint/config';
+import xoBrowser from 'eslint-config-xo/browser';
+import eslintPluginUnicorn from 'eslint-plugin-unicorn';
+
+export default defineConfig([
+	{
+		extends: [xoBrowser, eslintPluginUnicorn.configs.recommended],
+		files: ['**/*.js'],
+	},
+]);

package/package.json

@@ -0,0 +1,32 @@
+{
+	"name": "@inclusive-design/eslint-config",
+	"version": "0.1.0",
+	"description": "Shareable ESLint configuration for the Inclusive Design Research Centre.",
+	"main": "index.js",
+	"type": "module",
+	"scripts": {
+		"lint": "eslint",
+		"test": "node --test"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/inclusive-design/eslint-config.git"
+	},
+	"keywords": [
+		"eslint"
+	],
+	"author": {
+		"name": "OCAD University",
+		"email": "idrc@ocadu.ca"
+	},
+	"license": "BSD-3-Clause",
+	"bugs": {
+		"url": "https://github.com/inclusive-design/eslint-config/issues"
+	},
+	"homepage": "https://github.com/inclusive-design/eslint-config#readme",
+	"dependencies": {
+		"eslint": "^9.0.0",
+		"eslint-config-xo": "^0.49.0",
+		"eslint-plugin-unicorn": "^62.0.0"
+	}
+}

package/release-please-config.json

@@ -0,0 +1,11 @@
+{
+	"$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json",
+	"release-type": "node",
+	"include-component-in-tag": false,
+	"pull-request-title-pattern": "chore(release): release ${version}",
+	"packages": {
+		".": {
+			"package-name": "@inclusive-design/eslint-config"
+		}
+	}
+}

package/renovate.json

@@ -0,0 +1,23 @@
+{
+	"$schema": "https://docs.renovatebot.com/renovate-schema.json",
+	"extends": [
+		"config:recommended"
+	],
+	"lockFileMaintenance": {
+		"enabled": true,
+		"automerge": true
+	},
+	"labels": [
+		"dependencies"
+	],
+	"packageRules": [
+		{
+			"matchUpdateTypes": [
+				"minor",
+				"patch"
+			],
+			"matchCurrentVersion": "!/^0/",
+			"automerge": true
+		}
+	]
+}