Skip to content

suggest plugin id from display name #2

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

Open
HeyEvgenii wants to merge 1 commit into
base: master
Choose a base branch
from
Open

suggest plugin id from display name #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,17 @@ const initData: BoltInitData = {
if (!process.env.BOLT_MODULEONLY) main(initData);
```

### Suggested Plugin IDs

If your template has an arg named `displayName` and an arg named `id`, the `id` prompt is pre-filled from the display name the user just entered, by swapping the name segment of the default `id` you declared:

| your `initialValue` | user types | prompt suggests |
| ------------------- | ----------------------- | ------------------------------- |
| `com.bolt.uxp` | photoshop automator | `com.PhotoshopAutomator.uxp` |
| `com.bolt.cep` | after effects automator | `com.AfterEffectsAutomator.cep` |

The suffix comes from your own default, so each project keeps its own convention. It's only a suggestion — the user can type over it. Your default is used unchanged if the display name has no usable characters, or if the `id` has no name segment to swap.

Once you've built out your template with all the options for your project, now you will need to update your template to be dynamic with this create script.

You can accomplish this by:
Expand Down
29 changes: 28 additions & 1 deletion src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,22 @@ const handleCancel = (value: unknown) => {
}
};

const toPascalCase = (text: string) =>
text
.replace(/\w+/g, (word) => word[0].toUpperCase() + word.slice(1))
.replace(/\W/g, "");

/**
* get suggested ID from user typed displayName
* eg "photoshop automator" will suggest "com.PhotoshopAutomator.uxp"
*/
const suggestIdFromDisplayName = (defaultId: string, displayName: unknown) => {
const nameSegment =
typeof displayName === "string" ? toPascalCase(displayName) : "";
if (!nameSegment) return defaultId; //if no value return default
return defaultId.replace(/\.[^.]+\./, `.${nameSegment}.`);
};

export const main = async (
initData: BoltInitData,
overrideArgs: ResArgs = {}
Expand All @@ -58,11 +74,22 @@ export const main = async (

let res;
if (arg.type === "folder" || arg.type === "string") {
//everything answered so far so the id prompt can read the display name
const answeredArgs: ResArgs = {
...cliArgs,
...promptArgs,
...overrideArgs,
};
const initialValue =
arg.name === "id"
? suggestIdFromDisplayName(arg.initialValue, answeredArgs.displayName)
: arg.initialValue;

let completed = false;
while (!completed) {
res = (await text({
message: arg.message,
initialValue: arg.initialValue,
initialValue,
validate: arg.validator,
})) as string;
if (arg.type === "folder") {
Expand Down