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

Configure default naming convention for target files #161

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open

Configure default naming convention for target files #161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
a688d46
Implemented naming convention enforcement
Droxx May 8, 2023
98e98e1
Updated readme.md
Droxx May 8, 2023
11e83cf
updated contributors
Droxx May 8, 2023
f76967a
Updated readme
Droxx May 8, 2023
833dfae
Refactored new code into new file
Droxx May 8, 2023
a35d3e9
Using an NPM package for cleaner code
Droxx May 8, 2023
9f33ad8
Spelling
Droxx May 8, 2023
7d5df73
Addressed feedback from @hilleer
Droxx May 22, 2023
d3049b1
Merge branch 'main' into configure-default-naming-convention-for-targ…
Droxx May 22, 2023
514d50e
updated package.lock
Droxx May 22, 2023
53c868d
Merge branch 'main' into configure-default-naming-convention-for-targ…
Droxx Jun 9, 2023
b2ba42e
removed 'none' from package.json
Droxx Jun 9, 2023
d909d77
Merge branch 'configure-default-naming-convention-for-target-files' o…
Droxx Jun 9, 2023
fc0895a
removed TS ignore by specifying object as key-accessible
Droxx Jun 9, 2023
cc4a828
Merge branch 'main' into configure-default-naming-convention-for-targ…
Droxx Jun 22, 2023
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
31 changes: 21 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,15 @@ Any good ideas or feature requests? Please, do not hesitate to open [a new issue
* Convert a selection of YAML files to JSON by right clicking one of the selected files and selecting `Convert selected files to JSON`.
* Convert YAML files in a directory to JSON by right clicking the directory and selecting `Convert YAML files to JSON`.
* Convert JSON files in a directory to YAML by right clicking the directory and selecting `Convert JSON files to YAML`.
* **Change naming convention of converted files**
* Converted files can enforce a naming convention on property keys by setting `enforceNamingConvention` in config. This will apply the configured naming convention to converted properties
* For example, a JSON file with properties `TestProperty`, `example-array`, and `snake_property`. Would become a YAML file with the properties `testProperty`, `exampleArray`, and `snakeProperty`, if enforceNamingConvention was set to `camelCase` for YAML files.


* Reverting converted files: When a file has been reverted, a _"revert"_ prompt will be shown to revert it. Using this will return the entirety of the original file, including YAML comments.
* Overwriting existent files: When trying to convert a file into a destination that already exist, you can use the `overwriteExistentFiles` configuration to overwrite such. **Notice** if you use the revert feature after overwriting a file, the extension cannot (currently) revert the overwritten file. Also, due to limitation in vscode of active user prompts, if you set it to `"ask"` you will only be prompted to overwrite N number of files, while others will be skipped.


## Config

All configurations should be defined in `yaml-plus-json` in vscode settings (e.g. `.vscode/settings.json`), like:
Expand All @@ -41,21 +46,27 @@ All configurations should be defined in `yaml-plus-json` in vscode settings (e.g
"fileExtensions": {
"yaml": ".yaml",
"json": ".json"
},
"enforceNamingConvention": {
"yaml": "camelCase",
"json": "kebab-case"
}
}
}
```

| id | description | type | default | example |
|--------------------------|---------------------------------------------------------------------------------------------------------------------------|---------|-----------|------------|
| `convertOnRename` | Convert YAML/JSON files on rename | boolean | `true` | `false` |
| `yamlIndent` | The number of spaces to use when indenting code (yaml) | number | `2` | `4` |
| `yamlSchema` | See [yaml module documentation](https://github.com/eemeli/yaml/blob/master/docs/03_options.md#schema-options) for details | string | `"core"` | `"json"` |
| `fileExtensions` | define what filename extension(s) to use when converting file(s) | object | | |
| `fileExtensions.yaml` | yaml filename extension | string | `".yaml"` | `".yml"` |
| `fileExtensions.json` | json filename extension | string | `".json"` | `".json"` |
| `keepOriginalFiles` | Keep original files when converting. Use `"ask"` to be asked every time or `"always"` to always keep original files | string | | `"always"` |
| `overwriteExistentFiles` | Overwrite existent files when converting. Use `"ask"` to be asked every time or `"always"` to always overwrite | string | | `"always"` |
| id | description | type | default | example |
|-----------------------------------|---------------------------------------------------------------------------------------------------------------------------|---------|-----------|------------------|
| `convertOnRename` | Convert YAML/JSON files on rename | boolean | `true` | `false` |
| `yamlIndent` | The number of spaces to use when indenting code (yaml) | number | `2` | `4` |
| `yamlSchema` | See [yaml module documentation](https://github.com/eemeli/yaml/blob/master/docs/03_options.md#schema-options) for details | string | `"core"` | `"json"` |
| `fileExtensions` | define what filename extension(s) to use when converting file(s) | object | | |
| `fileExtensions.yaml` | yaml filename extension | string | `".yaml"` | `".yml"` |
| `fileExtensions.json` | json filename extension | string | `".json"` | `".json"` |
| `enforceNamingConvention.yaml` | apply a naming convention to converted yaml files | string | | `"kebab-case"` |
| `enforceNamingConvention.json` | apply a naming convention to converted json files | string | | `"PascalCase"` |
| `keepOriginalFiles` | Keep original files when converting. Use `"ask"` to be asked every time or `"always"` to always keep original files | string | | `"always"` |
| `overwriteExistentFiles` | Overwrite existent files when converting. Use `"ask"` to be asked every time or `"always"` to always overwrite | string | | `"always"` |

---

Expand Down
Loading