Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update formating, linting, and some dependencies #1117

Merged
merged 9 commits into from
Mar 10, 2025
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 0 additions & 45 deletions .eslintrc.json

This file was deleted.

17 changes: 7 additions & 10 deletions .github/ISSUE_TEMPLATE/BUGS.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
name: "Bug Report 🪲"
description: Report an issue or possible bug with the functionality of the Solid docs website. (Not related to the content of the site.)
title: "[Bug]: "
labels: [
"bug",
"pending review"
]
assignees:
- danieljcafonso
- atilafassina
labels: ["bug", "pending review"]
assignees:
- danieljcafonso
- atilafassina

body:
- type: textarea
Expand All @@ -25,21 +22,21 @@ body:
description: Please indicate on which page(s) the issue occurs.
placeholder: https://docs.solidjs.com/concepts/intro-to-reactivity
validations:
required: true
required: true
- type: textarea
id: expected
attributes:
label: "🤔 Expected Behavior"
description: Please describe what the expected behavior should be.
placeholder: When on this page, I expected . . .
placeholder: When on this page, I expected . . .
validations:
required: true
- type: textarea
id: current
attributes:
label: "👀 Current Behavior"
description: Please describe what the current behavior is.
placeholder: But instead, on this page I'm noticing . . .
placeholder: But instead, on this page I'm noticing . . .
validations:
required: true
- type: input
Expand Down
14 changes: 6 additions & 8 deletions .github/ISSUE_TEMPLATE/CONTENT.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
name: "Content Report 📄"
title: "[Content]:"
description: Report an issue with existing content.
labels: [
"improve documentation", "pending review"
]
assignees:
- ladybluenotes
labels: ["improve documentation", "pending review"]
assignees:
- ladybluenotes
body:
- type: markdown
attributes:
Expand All @@ -25,19 +23,19 @@ body:
description: Please provide the URL of the page(s) affected.
placeholder: https://docs.solidjs.com/concepts/intro-to-reactivity
validations:
required: true
required: true
- type: textarea
id: generalDesc
attributes:
label: "📋 Description of content that is out-of-date or incorrect"
description: Let us know what's wrong!
placeholder: "..."
validations:
required: true
required: true
- type: textarea
id: incorrectContent
attributes:
label: "🖥️ Reproduction in StackBlitz (if reporting incorrect content or code samples)"
description: If you are reporting incorrect content or code samples, you can also attach a reproduction in stackblitz.
validations:
required: false
required: false
6 changes: 2 additions & 4 deletions .github/ISSUE_TEMPLATE/OTHER.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
name: "Other Report 🌐"
title: "[Other]:"
description: Report something else we should know about the docs site!
labels: [
"pending review"
]
labels: ["pending review"]
body:
- type: textarea
id: issue
Expand All @@ -12,4 +10,4 @@ body:
description: Please describe the problem with the documentation in detail.
placeholder: "..."
validations:
required: true
required: true
14 changes: 6 additions & 8 deletions .github/ISSUE_TEMPLATE/REQUEST.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
name: "Request 💡"
title: "[Request]:"
description: Share an idea.
labels: [
"request", "pending review"
]
labels: ["request", "pending review"]
assignees:
- ladybluenotes
- ladybluenotes
body:
- type: markdown
attributes:
Expand All @@ -14,7 +12,7 @@ body:
id: request-topic
attributes:
label: "What is this request related to?"
options:
options:
- Request
- Styling
- Feature
Expand All @@ -27,20 +25,20 @@ body:
description: Please provide the URL of the page(s) or section this idea is related to.
placeholder: https://docs.solidjs.com/concepts/intro-to-reactivity
validations:
required: false
required: false
- type: textarea
id: generalDesc
attributes:
label: "📋 General description or bullet points"
description: Please provide a general description or bullet points about what you would like to see added.
placeholder: "..."
validations:
required: true
required: true
- type: textarea
id: example
attributes:
label: "🖥️ Reproduction of code samples in StackBlitz"
description: If you would like to suggest code samples please attach a working reproduction.
placeholder: "..."
validations:
required: false
required: false
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ blank_issues_enabled: true
contact_links:
- name: Support & Community 💁
url: https://discord.com/invite/solidjs
about: 'This issue tracker is not for support questions. Our Discord server hosts the community of Solid users. Come join us to discuss Solid or find assistance!'
about: "This issue tracker is not for support questions. Our Discord server hosts the community of Solid users. Come join us to discuss Solid or find assistance!"
1 change: 1 addition & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
- [ ] This PR references an issue (except for typos, broken links, or other minor problems)

### Description(required)

<!-- Provide a detailed description of the changes in this PR. Why is it necessary, and what does it do? -->

### Related issues & labels
Expand Down
21 changes: 21 additions & 0 deletions .github/actions/install/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Install Tools & Dependencies
description: Installs pnpm, Node.js & package dependencies

runs:
using: composite
steps:
- name: Setup pnpm
uses: pnpm/action-setup@v4
with:
version: 9
run_install: false

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
cache: pnpm

- name: Install dependencies
run: pnpm install
shell: bash
21 changes: 21 additions & 0 deletions .github/workflows/format.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Install Tools & Dependencies
description: Installs pnpm, Node.js & package dependencies

runs:
using: composite
steps:
- name: Setup pnpm
uses: pnpm/action-setup@v4
with:
version: 9
run_install: false

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
cache: pnpm

- name: Install dependencies
run: pnpm install
shell: bash
69 changes: 18 additions & 51 deletions .github/workflows/static_checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,70 +2,37 @@ name: 🔍 Lint / Type Checks

on:
push:
branches: [main]
branches:
- main

pull_request:
branches: [main]
branches:
- main

jobs:
setup:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
with:
version: 9
- uses: actions/setup-node@v4
with:
node-version: "20"
cache: "pnpm"
- run: pnpm i
- uses: actions/cache/save@v4
with:
path: |
node_modules
~/.pnpm-store
key: ${{ runner.os }}-pnpm-${{ hashFiles('**/pnpm-lock.yaml') }}

typecheck:
needs: setup
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
with:
version: 9
- uses: actions/setup-node@v4
with:
node-version: "20"
cache: "pnpm"
- uses: actions/cache/restore@v4
with:
path: |
node_modules
~/.pnpm-store
key: ${{ runner.os }}-pnpm-${{ hashFiles('**/pnpm-lock.yaml') }}
- name: Check out code
uses: actions/checkout@v4

- name: Install tools & dependencies
uses: ./.github/actions/install

- name: Generate virtual modules
run: pnpm sync

- name: TypeScript check
run: pnpm check:types

lint:
needs: setup
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
with:
version: 9
- uses: actions/setup-node@v4
with:
node-version: "20"
cache: "pnpm"
- uses: actions/cache/restore@v4
with:
path: |
node_modules
~/.pnpm-store
key: ${{ runner.os }}-pnpm-${{ hashFiles('**/pnpm-lock.yaml') }}
- name: Check out code
uses: actions/checkout@v4

- name: Install tools & dependencies
uses: ./.github/actions/install

- name: ESLint check
run: pnpm check:lint
11 changes: 10 additions & 1 deletion .prettierrc
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,14 @@
"tabWidth": 2,
"semi": true,
"singleQuote": false,
"useTabs": true
"useTabs": true,
"overrides": [
{
"files": "*.mdx",
"options": {
"proseWrap": "never",
"parser": "mdx"
}
}
]
}
Loading
Loading