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

Archive Project? #4

Open
SethFalco opened this issue Jul 24, 2021 · 1 comment · May be fixed by #5
Open

Archive Project? #4

SethFalco opened this issue Jul 24, 2021 · 1 comment · May be fixed by #5

Comments

@SethFalco
Copy link
Member

SethFalco commented Jul 24, 2021

It looks like this project can be archived?

What this extension would do, is literally just a setting in Visual Studio Code.
If you're adamant on helping users configure it, I think describing the setting in the documentation would be better.

That'd also provide a standardized solution that helps users be more productive with the editor, rather than a special one-off solution just for JSON Resume.

image

"json.schemas": [
  {
    "fileMatch": [
      "resume.json",
      "*.resume.json"
    ],
    "url": "https://raw.githubusercontent.com/jsonresume/resume-schema/v1.0.0/schema.json"
  }
]

Visual Studio Code also documents that one can use JSON Schema Store (on GitHub) to fetch JSON schemas to use in the $schema property. JSON Schema Store includes an entry for JSON Resume in its catalog.

The JSON support shipped with VS Code supports JSON Schema Draft 7.

Servers like JSON Schema Store provide schemas for most of the common JSON-based configuration files.
- https://code.visualstudio.com/Docs/languages/json#_json-schemas-and-settings

image

The only difference is that this project matches **/*resume.json and **/*.resume.json.
Schema Store currently only matches resume.json.

I've made a PR there to match the same files as this repository, plus the .yaml and .yml extensions, as they're supported by resume-cli.


The most popular YAML extension (redhat-developer/vscode-yaml) (third-party) automatically fetches JSON Schemas from JSON Schema Store and validates against it.

The JSON extension (built-in) doesn't do this yet. However, all example resumes and resume-cli set the $schema property by default, and getting IntelliSense enabled can otherwise be configured easily by users, and documented on the website if desirable.

The same support for JSON files will hopefully come eventually, an issue is being tracked for it here:

When that's done, matching the JSON files will become default behavior of Visual Studio Code.


Overall, I think it'd be better to archive this repository and update the top of the README with instructions on how they could configure it themselves. (shown at the start of this issue)
It could also be nice to include a link to the issue on microsoft/vscode just to get it some more attention.

@SethFalco SethFalco linked a pull request Jul 26, 2021 that will close this issue
@dotWee
Copy link

dotWee commented Sep 24, 2024

I agree with archiving this extension.

The built-in JSON support in VS Code along with the Red Hat YAML extension provide excellent schema validation for JSON Resume files without needing a separate extension.
Documenting the built-in VS Code settings would be more maintainable going forward.

+1 for archiving and updating the README with configuration instructions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants