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.

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

refactor!: rename some options #431

Merged
merged 12 commits into from
Mar 16, 2021
Merged

refactor!: rename some options #431

merged 12 commits into from
Mar 16, 2021

Conversation

brodybits
Copy link
Owner

(part of release 0.2.0 as discussed in #409)

  • rename --module-name option to --package-name
  • rename --package-identifier option to '--native-package-id`
  • rename --example-react-native-version to --example-react-native-template
  • update description & help text of the affected options
  • add a space to indenting of options in logging

BREAKING CHANGE: affects anyone using the renamed options

@brodybits brodybits self-assigned this Mar 12, 2021
@brodybits brodybits marked this pull request as ready for review March 16, 2021 04:02
@brodybits brodybits merged commit 8bfc561 into master Mar 16, 2021
@brodybits brodybits deleted the rename-some-options branch March 16, 2021 04:06
brodybits added a commit that referenced this pull request Mar 16, 2021
  also fixes minor misalignment that was introduced
  in 8bfc561
  (PR #431)
brodybits added a commit that referenced this pull request Mar 16, 2021
* refactor: nudge indenting of options in logging

  also fixes minor misalignment that was introduced
  in 8bfc561
  (PR #431)

* update test snapshot
@asklar
Copy link
Contributor

asklar commented Mar 18, 2021

@brodybits FYI this change broke our CI since we use create-react-native-module --module-name and the new npm package version doesn't have that option; it sounds like this should have required a major version update. #441

BartoszKlonowski added a commit to callstack-internal/react-native-windows-samples that referenced this pull request May 21, 2021
The code presented in the docs for creating the NativeModuleSample still
had the --module-name  option, which was renamed to  --package-name  in:
brodybits/create-react-native-module#431

This commit removes this option, as the --package-name is optional and
by default the name will be set as the one used as second parameter.
NickGerleman pushed a commit to microsoft/react-native-windows-samples that referenced this pull request May 24, 2021
…odule` (#440)

* Remove --module-name option from module creation code

The code presented in the docs for creating the NativeModuleSample still
had the --module-name  option, which was renamed to  --package-name  in:
brodybits/create-react-native-module#431

This commit removes this option, as the --package-name is optional and
by default the name will be set as the one used as second parameter.

* Separate `create-react-native-module` as another option

Official React Native instructions use react-native-builder-bob from
Callstack.io company to create the native module project, while the
example presented below it uses other community library.
It is essential to emphasize that these are not the same ways to create
the project.
This commit adds "or" to ensure that the reader will be aware of those
options.
matsudaWWW added a commit to matsudaWWW/reactNative-sample that referenced this pull request Dec 17, 2023
…odule` (#440)

* Remove --module-name option from module creation code

The code presented in the docs for creating the NativeModuleSample still
had the --module-name  option, which was renamed to  --package-name  in:
brodybits/create-react-native-module#431

This commit removes this option, as the --package-name is optional and
by default the name will be set as the one used as second parameter.

* Separate `create-react-native-module` as another option

Official React Native instructions use react-native-builder-bob from
Callstack.io company to create the native module project, while the
example presented below it uses other community library.
It is essential to emphasize that these are not the same ways to create
the project.
This commit adds "or" to ensure that the reader will be aware of those
options.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants