-
-
Notifications
You must be signed in to change notification settings - Fork 131
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
Configure various dev tools #894
Open
Steffo99
wants to merge
19
commits into
cheeaun:main
Choose a base branch
from
Steffo99:feature/devtools
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It's intended for all files inside to be committed, as they act for pre-packaged configuration for the project.
It manages its own ignores via `.idea/.gitignore`, and can optionally be excluded with `.git/info/exclude` in case.
Set to "Phanpy"
This makes it easier to filter out files not to be edited directly in the editor.
Vite's default 5173 is unused, but unofficial
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request pre-configures various dev tools to allow an easier onboarding for potential new developers.
In particular:
The
.vscode
and.idea
directories are unexcluded, as they're not supposed to be excluded in first place.idea
directory is left to be managed by IDE itself via the.idea/.gitignore
file in itThe
.vscode
directory is pre-populated with settings to aid development in VSCode:A run configuration to launch Phanpy on port 8080 and to open an instance of a Chromium-based browser in debug mode on it as soon as the server is done launching:
A recommendation for the
github.vscode-github-actions
extension that adds features to work on GitHub Actions files, such as proper syntax highlighting:If the user has File Nesting enabled (it is not by default), its settings are extended to group together
*.tsx
,*.jsx
,*.ts
,*.js
,*.module.css
and*.css
files with the same name:The
src/locales
andnode_modules
directories are hidden by default from the file explorer and excluded from search, as they're not meant to be edited by handThe
.devcontainer
directory is created with a basic but functional configuration to develop Phanpy in a development container, such as the ones provided by GitHub CodespacesThe
.idea
directory is pre-populated too with settings to aid development in Jetbrains' IDEs:Project name has been set to "Phanpy" instead of whatever the current working directory is called
Code style settings are setup to be overridden by the project, which copies the Prettier features built-in in the IDE
Basic module structure
A «Scope» is setup to mark localization files managed by Crowdin with a red colour, denoting that they should not be edited
The port for the development server has been changed from
5173
to8080
; while both are well-known for Vite development, only the latter is officially registered with the IANA for web developmentMetadata is added to
package.json
to prevent accidental publishing ("private": true
) and to have additional information if neededThe
prettier-pr.yml
GitHub Action is extended to allow it to automatically prettify files, instead of just checking themSince this is a lot of opinionated stuff, if you're not comfortable with merging parts of it, I'd recommend you to cherry-pick the commits you think might be interesting, or to tell me which parts you like so that I can cherry-pick for you!