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.

Sign up for GitHub

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

Jump to bottom

Update import map name to reflect conventional usage #338

Closed
MichaelCurrin opened this issue Feb 20, 2021 · 3 comments · Fixed by #340
Closed

Update import map name to reflect conventional usage #338

MichaelCurrin opened this issue Feb 20, 2021 · 3 comments · Fixed by #340
Labels
documentation Improvements or additions to documentation

Comments

@MichaelCurrin
Copy link

MichaelCurrin commented Feb 20, 2021 •
edited
Loading

test

Describe the bug

The extension recommends import-map.json with a dash, in a few places.

It would be preferable to recommend import_map.json with an underscore, to match the Deno docs - Import maps.

This is not a big deal, but I am fan of consistency. I'd rather encourage users to use the same convention as in the official Deno docs. And avoid someone overlooking a hyphen and an underscore and scratching their head at results.

To Reproduce

This affects someone reading the help text / docs in README.md.

Also, when editing the settings, start editing the import map field and use the auto-fill feature, or wait for the help text to pop up.

The file path to an import map. This is the equivalent to using --import-map on the command line

Expected behavior

All messaging in the settings help and the docs should to import_map.json as the first option.

Screenshots

Deno docs:

docs

Hover:

hover

Autofill

autofill

Search for affected areas: q=import-map

Versions

vscode: not relevant
deno: 1.7 but not relevant
extension: v3.0.1
@MichaelCurrin MichaelCurrin changed the title Update import map text to reflect recommended usage Update import map name to reflect conventional usage Feb 20, 2021
@MichaelCurrin
Copy link
Author

Thanks.

@kitsonk
Copy link
Contributor

kitsonk commented Feb 20, 2021

A PR adjusting this would be accepted.

@kitsonk kitsonk added the documentation Improvements or additions to documentation label Feb 20, 2021
@Liamolucko Liamolucko mentioned this issue Feb 20, 2021
Merged
kitsonk pushed a commit that referenced this issue Feb 20, 2021
@Liamolucko
docs: recommend import_map.json instead of import-map.json (#340)
b2c8048 
Resolves #338
@MichaelCurrin
Copy link
Author

Thanks for the quick response and PR.

LumaKernel added a commit to LumaKernel/coc-denoland that referenced this issue Aug 7, 2021
@LumaKernel @kitsonk
@lucacasonato @Kirlovon @Liamolucko @ry @jsejcksn @CGQAQ @dsherret @hectormenendez @fannheyward @satyarohith @yaegassy @cvng
feat: merge v3.7.0 (#8)
fd7f096 
* feat: code lens for references (denoland#308)

* feat: disable most of builtin language service when deno enabled (denoland#307)

* 0.0.8

* feat: add applyCodeActionCommand command (denoland#312)

* fix: remove deno/applyCodeActionCommand (denoland#315)

* New high-res logo (denoland#274)

* feat: add implementations code lens configuration option (denoland#319)

* feat: add initialize workspace command (denoland#316)

* feat: support deno cache quick fix (denoland#322)

* chore: add screenshot to README (denoland#323)

* 0.0.9

* 0.0.10

* fix: typo in init command (denoland#327)

* feat: add a welcome screen for extension (denoland#329)

* feat: use preview instead of display for status (denoland#330)

* chore: README improvements (denoland#331)

* Release 3.0.0, canary is now main (denoland#332)

* 3.0.1

* Fix typo (denoland#337)

Grammar + context

* chore: activate extension on command (denoland#336)

* docs: recommend import_map.json instead of import-map.json (denoland#340)

Resolves denoland#338

* chore: move Releases.md to CHANGELOG.md for better marketplace integration (denoland#344)

Closes denoland#342

* feat: add deno.path setting (denoland#350)

* 3.1.0

* feat: read-add debug support (denoland#351)

Co-authored-by: CGQAQ <[email protected]>

* feat: add settings to affect completions (denoland#368)

* fix: manual `deno` command resolution on windows. (denoland#367)

Fixes denoland#361

* 3.2.0

* feat: support for relative path resolution (using workspaces) in deno.path (denoland#381)

Co-authored-by: Kitson Kelly <[email protected]>

* feat: add version notification message (denoland#383)

* feat: add restart language server command (denoland#385)

Resolves denoland#372

* feat: add support for import registry completions (denoland#380)

* 3.3.0

* typo in ImportCompletions.md (denoland#390)

* fix: activate on reloadImportRegistries command (denoland#407)

Fixes: denoland#394

* feat: handle per resource configuration (denoland#411)

Requires Deno with denoland/deno#10488.

Ref: denoland#348 
Resolves: denoland#314
Resolves: denoland#297

* feat: add internalDebug config flag (denoland#406)

Also integrate upstream formatting changes in deno fmt.

Ref: denoland/deno#10368

* 3.4.0

* feat: recognise json(c) & markdown files (denoland#404)

* 3.5.0

* docs: fix broken link in README (denoland#426)

* feat: support registry auto discovery (denoland#427)

* fix: bump semver of extension (denoland#429)

* 3.5.1

* feat: add support for tasks and test code lens (denoland#436)

* 3.6.0

* fix: update packaging and pin vsce version (denoland#440)

Fixes denoland#439

* 3.6.1

* feat: add support for import map in test code lens (denoland#446)

* fix: activate extension on markdown / json / jsonc (denoland#447)

* fix: setting then clearing "deno.path" config should not use empty string for path (denoland#452)

* fix: better handling when language server fails to start (denoland#454)

* 3.7.0

* fix: remove trailing slash in example (denoland#471)

* chore: remove test header from bug report issue template (denoland#479)

* feat: add ability to set cache directory in settings (denoland#477)

Closes denoland#287

* fix: properly handle plugin configuration at startup (denoland#474)

Fixes denoland#473

Co-authored-by: Kitson Kelly <[email protected]>
Co-authored-by: Luca Casonato <[email protected]>
Co-authored-by: Kirill Reunov <[email protected]>
Co-authored-by: Liam Murphy <[email protected]>
Co-authored-by: Ryan Dahl <[email protected]>
Co-authored-by: Jesse Jackson <[email protected]>
Co-authored-by: CGQAQ <[email protected]>
Co-authored-by: David Sherret <[email protected]>
Co-authored-by: Hector Menendez <[email protected]>
Co-authored-by: Heyward Fann <[email protected]>
Co-authored-by: Satya Rohith <[email protected]>
Co-authored-by: yaegassy <[email protected]>
Co-authored-by: Cedric Vangout <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: recommend import_map.json instead of import-map.json Liamolucko/vscode_deno
2 participants
@kitsonk @MichaelCurrin