the-guild-org/shared-config

A collection of config, setups, pipelines and GitHub Actions we use in our tools

shared-config's Issues

bugs with sort import

1. css should be last

2. still sort side-effects imports

3. broken comments

add a rule to avoid `return await` unless you have `try/catch`

New rule: Disallow code blocks with `yarn add`/`npm i`/`pnpm i` and suggest using `<PackageCmd />`

for example here it should be PackageCmd only

https://github.com/hahn-kev/graphql-code-generator/blob/ebaf32f4b89717044ee0d59817e76248cd0e925b/website/src/pages/docs/guides/react-vue.mdx?plain=1#L46-L64

GitHub added support for Workflow `permissions`

https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#permissions

Related: ardatan/graphql-tools#4728

document how to sync labels

enable @typescript-eslint/no-use-before-define

https://tortilla-hq.slack.com/archives/C01SH2CL5PW/p1662735174351829

Add new rule for markdown - forbid point `.` at the end

document how to use shared prettier config

document how to use shared eslint config

Allow installing private npm packages if `NPM_TOKEN` is set

It looks like NPM_TOKEN is used in the "release" workflows, but not in the setup one. It is necessary when installing private dependencies.

add new rule for markdown, forbid bold style only `## **some heading**`

use latest tools and pipelines also for this repo :D

forbid ==, allow only for `== null` checks

saw in https://github.com/kamilkisiela/graphql-hive/blob/4f862ba2babab9848ccd8cc7309d6c1b5b29ddc1/packages/web/app/pages/%5BorgId%5D/%5BprojectId%5D/%5BtargetId%5D/history.tsx#L223

Exclude tests, tsx files from import/extensions

Retrieve package manager for workflows from package.json

shared-config/.github/workflows/changesets-dependencies.yaml

Lines 13 to 16 in 9875c3f

	packageManager:
	type: string
	required: false
	default: yarn

This can be read from the package.json instead:

{
  "name": "foooooo",
  "packageManager": "[email protected]"
}

lint ci jobs doesn't fails with errors due `continue-on-error`

https://guild-oss.slack.com/archives/C04U8J871A5/p1720696794184069

`changeset-dependencies` does not install dependencies

https://github.com/the-guild-org/shared-config/blob/main/.github/workflows/changesets-dependencies.yaml

needed in case of a project that has custom prettier config with external dependencies

related: n1ru4l/envelop#1583

Bot/Comment for releasing community PR as canary

Today we cannot easily publish contributor PRs as canaries because the workflows don't have access to our GitHub secrets (which is fine).

Instead we should have a way of pinging a bot that will import the branch into our repository and then release canary from there, and then comment on the original PR.

Recent GitHub deprecations for `set-output` and `save-state`

https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/

enable `eslint-plugin-unicorn/filename-case` rule for md,mdx files

add `import/extensions` to ensure js extension

https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/extensions.md

Allow for passing version number for package manger

Instead of doing based on packageManager for version we should have a new input that can be used to pin a version number.

In graph-tooling it uses pnpm as main package manager but some of integration tests use yarn and if yarn install is run in the CI where we pin with packageManager that makes it very cryptic to debug. Instead I force the version number using engines in package.json then being able to just define as an input to CI job would be sufficient

add a rule to simplify `./..` -> `../`

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Warning

These dependencies are deprecated:

Datasource	Name	Replacement PR?
npm	@types/marked

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

• chore(deps): update dependency eslint to v9
• fix(deps): update dependency eslint-plugin-promise to v7

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update dependency @types/node to v20.14.13
• chore(deps): update dependency typescript to v5.5.4
• chore(deps): update dependency cspell to v8.12.1
• chore(deps): update dependency tsup to v8.2.3
• chore(deps): update dependency @shopify/eslint-plugin to v46
• chore(deps): update dependency @types/eslint to v9
• chore(deps): update dependency eslint-remote-tester to v4
• fix(deps): update dependency @rushstack/eslint-patch to v1.10.4
• fix(deps): update dependency eslint-plugin-sonarjs to v1.0.4
• fix(deps): update dependency postcss to v8.4.40
• fix(deps): update dependency semver to v7.6.3
• fix(deps): update dependency eslint-plugin-n to v17.10.1
• fix(deps): update dependency eslint-plugin-promise to v6.6.0
• fix(deps): update dependency eslint-plugin-react to v7.35.0
• fix(deps): update typescript-eslint monorepo to v7.18.0 (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)
• fix(deps): update dependency marked to v13
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

github-actions

.github/workflows/algolia-integrity.yml

• actions/checkout v4
• marocchino/sticky-pull-request-comment v2
• ubuntu 22.04

.github/workflows/algolia-publish.yml

• actions/checkout v4
• EndBug/add-and-commit v9
• ubuntu 22.04

.github/workflows/changesets-dependencies.yaml

• actions/checkout v4
• ubuntu 22.04

.github/workflows/ci-node-matrix.yml

• actions/checkout v4
• ubuntu 22.04
• ubuntu 22.04

.github/workflows/ci.yml

• actions/checkout v4
• ubuntu 22.04

.github/workflows/lint.yml

• actions/checkout v4
• ataylorme/eslint-annotate-action v2
• ubuntu 22.04

.github/workflows/release-snapshot.yml

• actions/checkout v4
• the-guild-org/changesets-snapshot-action v0.0.1
• ubuntu 22.04

.github/workflows/release-stable.yml

• actions/checkout v4
• dotansimha/changesets-action v1.5.2
• ubuntu 22.04

setup/action.yml

• styfle/cancel-workflow-action 0.12.1
• pnpm/action-setup v4.0.0
• actions/setup-node v4

website-cf/action.yml

• cloudflare/pages-action v1.5.0
• peter-evans/find-comment v3
• peter-evans/create-or-update-comment v4

npm

package.json

• @changesets/changelog-github 0.5.0
• @changesets/cli 2.27.7
• @shopify/eslint-plugin 45.0.0
• @types/eslint 8.56.11
• @types/node 20.14.10
• cspell 8.10.4
• eslint 8.57.0
• eslint-remote-tester 3.0.1
• prettier 3.3.3
• ts-node 10.9.2
• typescript 5.5.3
• node >=21.6
• pnpm >=9.0.6
• pnpm 9.6.0

packages/eslint-config/package.json

• @rushstack/eslint-patch ^1.6.1
• @typescript-eslint/eslint-plugin ^7.0.0
• @typescript-eslint/parser ^7.0.0
• eslint-config-prettier ^9.1.0
• eslint-import-resolver-typescript ^3.6.1
• eslint-plugin-import ^2.29.1
• eslint-plugin-jsonc ^2.11.1
• eslint-plugin-jsx-a11y ^6.8.0
• eslint-plugin-mdx ^3.0.0
• eslint-plugin-n ^17.0.0
• eslint-plugin-promise ^6.1.1
• eslint-plugin-react ^7.33.2
• eslint-plugin-react-hooks ^4.6.0
• eslint-plugin-sonarjs ^1.0.0
• eslint-plugin-unicorn ^55.0.0
• eslint-plugin-yml ^1.11.0
• eslint ^8
• typescript ^5

packages/prettier-config/package.json

• @ianvs/prettier-plugin-sort-imports 4.3.1
• prettier-plugin-pkg ^0.18.0
• prettier-plugin-sh ^0.14.0
• prettier ^3

packages/tailwind-config/package.json

• autoprefixer ^10.4.19
• cssnano ^7.0.0
• postcss ^8.4.38
• postcss-import ^16.1.0
• tailwindcss ^3.4.3
• postcss-load-config 6.0.1
• tsup ^8.0.2

release-trackback/package.json

• @actions/core 1.10.1
• @actions/github 6.0.0
• marked 12.0.2
• semver 7.6.2
• @types/marked 6.0.0
• @types/node 20.14.10
• @types/semver 7.5.8
• @vercel/ncc 0.38.1
• typescript 5.5.3

---

• Check this box to trigger a request for Renovate to run again on this repository

typescript-eslint.io/non-nullable-type-assertion-style

https://typescript-eslint.io/rules/non-nullable-type-assertion-style/

and add new config that requires type info