Skip to content

Commit

Permalink
chore: organize codebase (#313)
Browse files Browse the repository at this point in the history
* style: add eslint with antfu

* fix: update vscode settings

* chore: add linting config and required packages

* chore: remove unneeded file from package

* style: allow console log

* chore: add name and repo in `package.json`

* chore: update issue template

* chore: update pr template and move into `.github` dir

* fix: update description and add field for reproduction link

* chore: cleanup

* fix: use domain based url for invite link

* chore: add script for linting
  • Loading branch information
mukundshah committed Aug 19, 2023
1 parent d12e15e commit 87ca501
Show file tree
Hide file tree
Showing 22 changed files with 1,185 additions and 225 deletions.
16 changes: 16 additions & 0 deletions .eslintrc.cjs
@@ -0,0 +1,16 @@
const process = require('node:process');

process.env.ESLINT_TSCONFIG = 'tsconfig.json';

module.exports = {

extends: ['@antfu'],

rules: {
'semi': ['error', 'always'],
'@typescript-eslint/semi': ['error', 'always'],
'vue/no-multiple-template-root': 'off',
'vue/component-options-name-casing': ['error', 'kebab-case'],
'no-console': ['warn', { allow: ['warn', 'error'] }],
},
};
85 changes: 85 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
@@ -0,0 +1,85 @@
name: 🐞 Bug report
description: Create a report to help us improve radix-vue.
title: '[Bug]: '
labels: [bug]
body:
- type: markdown
attributes:
value: |
**Before You Start...**
This form is only for submitting bug reports. If you have a usage question
or are unsure if this is really a bug, make sure to:
- Read the [docs](https://radix-vue.com/)
- Ask on [Discord Chat](https://chat.radix-vue.com/)
- Ask on [GitHub Discussions](https://github.com/radix-vue/radix-vue/discussions)
Also try to search for your issue - it may have already been answered or even fixed.
However, if you find that an old, closed issue still persists in the latest version,
you should open a new issue using the form below instead of commenting on the old issue.
- type: textarea
id: bug-env
attributes:
label: Environment
description: Please provide the following information about your environment.
value: |
Developement/Production OS: Windows 10 19043.1110
Node version: 16.0.0
Package manager: pnpm@8.6.0
Radix Vue version: 1.0.0
Vue version: 3.0.0
Nuxt version: 3.0.0
Nuxt mode: universal
Nuxt target: server
CSS framework: tailwindcss@3.3.3
Client OS: Windows 10 19043.1110
Browser: Chrome 90.0.4430.212
render: bash
validations:
required: true
- type: input
id: reproduction-link
attributes:
label: Link to minimal reproduction
description: |
Please provide a link to a minimal reproduction of the bug.
A minimal reproduction is a CodeSandbox, CodePen, or a StackBlitz that contains the bare minimum amount of code needed to show the bug.
A minimal reproduction is required unless you are absolutely sure that the issue is obvious and the provided information is enough to understand the problem
This is **required** for us to be able to triage your issue in a timely manner.
Please do not just fill in a random link. The issue will be closed if no valid reproduction is provided.
placeholder: Reproduction Link
validations:
required: true
- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to reproduce
description: |
How do you trigger this bug? Please walk us through it step by step.
Note that you can use [Markdown](https://guides.github.com/features/mastering-markdown/) to format lists and code.
placeholder: Steps to reproduce
validations:
required: true
- type: textarea
id: bug-description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks!
placeholder: Bug description
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
- type: textarea
id: screenshots
attributes:
label: Conext & Screenshots (if applicable)
description: |
If applicable, provide any additional context or screenshots of the bug.
You can drag and drop images here to add them to the issue.
38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: 📚 Documentation
url: https://www.radix-vue.com/
about: Check the documentation for usage of Radix Vue.
- name: 🗨️ Discord
url: https://chat.radix-vue.com/
about: Join the Radix Vue Discord server.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
@@ -0,0 +1,27 @@
name: 🚀 Feature request
description: Suggest a feature that will improve radix-vue.
title: '[Feature]: '
labels: [feature request]
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to fill out this feature request!
- type: textarea
id: feature-description
attributes:
label: Describe the feature
description: A clear and concise description of what you think would be a helpful addition to radix-vue, including the possible use cases and alternatives you have considered. If you have a working prototype or module that implements it, please include a link.
placeholder: Feature description
validations:
required: true
- type: checkboxes
id: additional-info
attributes:
label: Additional information
description: Additional information that helps us decide how to proceed.
options:
- label: I intend to submit a PR for this feature.
- label: I have already implemented and/or tested this feature.
validations:
required: false
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

46 changes: 0 additions & 46 deletions .github/ISSUE_TEMPLATE/rfc.md

This file was deleted.

35 changes: 35 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md.md
@@ -0,0 +1,35 @@
<!---☝️ PR title should follow conventional commits (https://conventionalcommits.org) -->

### 🔗 Linked issue

<!-- Please ensure there is an open issue and mention its number as #123 -->

### ❓ Type of change

<!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply. -->

- [ ] 📖 Documentation (updates to the documentation, readme or JSdoc annotations)
- [ ] 🐞 Bug fix (a non-breaking change that fixes an issue)
- [ ] 👌 Enhancement (improving an existing functionality like performance)
- [ ] ✨ New feature (a non-breaking change that adds functionality)
- [ ] 🧹 Chore (updates to the build process or auxiliary tools and libraries)
- [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

### 📚 Description

<!-- Describe your changes in detail -->
<!-- Why is this change required? What problem does it solve? -->
<!-- If it resolves an open issue, please link to the issue here. For example "Resolves #1337" -->

### 📸 Screenshots (if appropriate)

<!-- Add screenshots to help explain the change. -->

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->

- [ ] I have linked an issue or discussion.
- [ ] I have updated the documentation accordingly.
1 change: 1 addition & 0 deletions .gitignore
Expand Up @@ -20,6 +20,7 @@ coverage
# Editor directories and files
.vscode/*
!.vscode/extensions.json
!.vscode/settings.json
.idea
*.suo
*.ntvs*
Expand Down
6 changes: 5 additions & 1 deletion .vscode/extensions.json
@@ -1,3 +1,7 @@
{
"recommendations": ["Vue.volar"]
"recommendations": [
"Vue.volar",
"Vue.vscode-typescript-vue-plugin",
"dbaeumer.vscode-eslint"
]
}
20 changes: 20 additions & 0 deletions .vscode/settings.json
@@ -0,0 +1,20 @@
{
"editor.formatOnSave": false,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true,
"source.organizeImports": false
},
"eslint.validate": [
"javascript",
"javascriptreact",
"typescript",
"typescriptreact",
"vue",
"html",
"markdown",
"json",
"jsonc",
"yaml"
],
"typescript.tsdk": "node_modules/typescript/lib"
}
4 changes: 0 additions & 4 deletions docs/.eslintignore

This file was deleted.

8 changes: 0 additions & 8 deletions docs/.eslintrc.cjs

This file was deleted.

1 change: 0 additions & 1 deletion docs/package.json
Expand Up @@ -12,7 +12,6 @@
"devDependencies": {
"@nuxt-themes/docus": "^1.12.1",
"@nuxt/devtools": "^0.5.5",
"@nuxt/eslint-config": "^0.1.1",
"@nuxtjs/plausible": "^0.2.1",
"@types/node": "^20.2.5",
"eslint": "^8.42.0",
Expand Down
29 changes: 28 additions & 1 deletion package.json
@@ -1,12 +1,39 @@
{
"name": "radix-vue",
"private": true,
"packageManager": "pnpm@8.6.3",
"license": "MIT",
"repository": "radix-vue/radix-vue",
"workspaces": [
"packages/*"
],
"scripts": {
"story:dev": "pnpm --filter histoire story:dev",
"build": "pnpm run -r --filter=!docs build",
"start": "cd packages/radix-vue && pnpm i && pnpm run build && cd ../../playground/vue3 && pnpm i && pnpm i ../../packages/radix-vue && pnpm run dev"
"start": "cd packages/radix-vue && pnpm i && pnpm run build && cd ../../playground/vue3 && pnpm i && pnpm i ../../packages/radix-vue && pnpm run dev",
"prepare": "pnpm simple-git-hooks",
"lint": "eslint . --ignore-path .gitignore",
"lint:fix": "eslint . --fix --ignore-path .gitignore"
},
"devDependencies": {
"@antfu/eslint-config": "^0.39.7",
"@commitlint/cli": "^17.7.1",
"@commitlint/config-conventional": "^17.7.0",
"eslint": "^8.43.0",
"lint-staged": "^14.0.0",
"simple-git-hooks": "^2.9.0"
},
"commitlint": {
"extends": [
"@commitlint/config-conventional"
]
},
"simple-git-hooks": {
"pre-commit": "pnpm lint-staged",
"commit-msg": "pnpm commitlint --edit ${1}"
},
"lint-staged": {
"*": "eslint --fix"
}

}

0 comments on commit 87ca501

Please sign in to comment.