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

fix(cli-create): fix scoped creation #6239

Merged
merged 3 commits into from
Aug 13, 2018
Merged

fix(cli-create): fix scoped creation #6239

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5512472
fix(cli-create): fix scoped creation
iamstarkov Aug 6, 2018
bb30667
refactor(cli-create): make parsePackageName more robust and add tests
iamstarkov Aug 8, 2018
f82fe4f
refactor(cli-create): add missing typyings
iamstarkov Aug 8, 2018
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
41 changes: 37 additions & 4 deletions src/cli/commands/create.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,50 @@ export function hasWrapper(commander: Object, args: Array<string>): boolean {
return true;
}

const coerceName = (name = '') => (name === '' ? 'create' : `create-${name}`);
const coerceScope = (scope = '') => (scope === '@' ? '' : scope);
const coerceFullName = (scope, name) => [coerceScope(scope), coerceName(name)].filter(Boolean).join('/');

/**
* # Tests
*
* ## basic
* parseBuilderName('name').packageName === 'create-name'
* parseBuilderName('@scope/name').packageName === '@scope/create-name'
*
* ## not adding "-" if name is empty
* parseBuilderName('@scope/').packageName === '@scope/create'
* parseBuilderName('@scope').packageName === '@scope/create'
*
* ## edge cases
* parseBuilderName('@/name').packageName === 'create-name'
* parseBuilderName('/name').packageName === 'create-name'
* parseBuilderName('@/').packageName === 'create'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd prefer if you could put this in a file called __tests__/commands/create.js (you can just export the parseBuilderName symbol and require the file), so that they are actually ran. Otherwise the comment can just be removed, since it will never be run.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay, will do

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added tests

*/
const parseBuilderName = str => {
const parts = str.split('/');
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should reject as invalid if there's more than two parts, or if the first part doesn't start with a '@'

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good idea

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed parseBuilderName to parsePackageName and it throws error if first character is . or /. It also throws if scope equals @.

About throwing id there are more than 2 parts: and i want yarn to be robust so I just put that extra part into path field of pkgNameObject¹ and ignore it in rest of create command.

[1]:

'@scope/name/path/to/file.js' => pkgNameObject {
  fullName: '@scope/name',
  name: 'name',
  scope: '@scope',
  path: 'path/to/file.js',
  full: '@scope/name/path/to/file.js',
}

if (parts.length === 1 && !str.includes('@')) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

str.charAt(0) === '@' would be more correct, I think.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

right

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

return {
packageName: coerceName(str),
packageDir: '',
commandName: coerceName(str),
};
}
return {
packageName: coerceFullName(parts[0], parts[1]),
packageDir: coerceScope(parts[0]),
commandName: coerceName(parts[1]),
};
};

export async function run(config: Config, reporter: Reporter, flags: Object, args: Array<string>): Promise<void> {
const [builderName, ...rest] = args;

if (!builderName) {
throw new MessageError(reporter.lang('invalidPackageName'));
}

const packageName = builderName.replace(/^(@[^\/]+\/)?/, '$1create-');
const packageDir = packageName.replace(/^(?:(@[^\/]+)\/)?.*/, '$1');
const commandName = packageName.replace(/^@[^\/]+\//, '');

const {packageName, packageDir, commandName} = parseBuilderName(builderName);
await runGlobal(config, reporter, {}, ['add', packageName]);

const binFolder = await getBinFolder(config, {});
Expand Down