feat: file path as cti path (example mechanism for discussion) #253
Conversation
| @@ -48,6 +48,34 @@ function combineJSON(arr, deep, collision) { | |||
| throw e; | |||
| } | |||
|
|
|||
| if(useFilePathAsCTI) { | |||
| let filePath = path.relative('./', files[i]); | |||
There was a problem hiding this comment.
I think it might be too restricting to assume that the names should start from the current working directory. For example we would run the command from our package root, but our properties were in <root>/src/tokens/<properties>. In that case everything would be prefixed with "srcTokens". What if "rootPath" or something was a configuration option? That would also solve the issue you commented about on line 59 with assuming a "properties" folder name.
There was a problem hiding this comment.
👍🏽 Good call on all accounts
| if(ctisetup.length > 1) { | ||
| ctisetup.pop(); | ||
| } | ||
| ctisetup = ctisetup.join('.').split('/'); |
There was a problem hiding this comment.
Minor, but I think .split(path.sep) is more cross-platform-proof.
|
FWIW I don't think the duplication is a big deal. It doesn't feel like something that needs to be built in since the only purpose would be to help with migrating, right? If it's an issue maybe a migration script would be nice... |
|
Since DTCG spec, token.type tends to be used to determine token type and users can use the token.filePath to create a name transform that takes that into account as well as the token hierarchy/path to determine the final token name. I think that makes this PR redundant and since it's 5 years old, I'll close for now |
#104, part of #251
Added in options in config to use file path as CTI prefix.
This is meant to start discussion of value here.
The options to use in the config are 'sourceFilePathAsCTI' and 'includeFilePathAsCTI'.
Note that I did not attempt to solve the problem if you are using the current system, which would result in a duplication of information in the CTI as per @elliotdickison's comments. (e.g. A file in the path properties/fonts/size.json containing { fonts: { size: { small: value: '10px'; } } } using this option would result in fonts.size.fonts.size.small).
If we like this, I can add tests and add in functionality to detect and remove duplication. Also, let me know if I should remove that top level folder if it is called "properties", or what we should do to handle that.....