feat(crnl): store metadata with new projects #551
Conversation
tsconfig.json
Outdated
| @@ -1,4 +1,9 @@ | |||
| { | |||
| "include": [ | |||
| "packages/create-react-native-library/src", | |||
| "packages/create-react-native-library/package.json", | |||
There was a problem hiding this comment.
import { version as crnlVersion } from '../package.json'; This line was generating errors during typecheck without including.
|
|
||
| spinner.text = 'Writing metadata'; | ||
| fs.writeJsonSync( | ||
| path.join(folder, 'create-react-native-library.json'), |
| crnlVersion, | ||
| languages, | ||
| projectType: type, |
There was a problem hiding this comment.
Let's include everything by default and then exclude some which are not needed
| @@ -787,6 +794,21 @@ async function create(argv: yargs.Arguments<any>) { | |||
| } | |||
| } | |||
|
|
|||
| const metadata: Metadata = { | |||
| crnlVersion, | |||
There was a problem hiding this comment.
| crnlVersion, | |
| version, |
| const createdPackageJson = fs.readJsonSync(path.join(folder, 'package.json')); | ||
| createdPackageJson['create-react-native-library'] = filteredAnswers; | ||
| fs.writeJsonSync(path.join(folder, 'package.json'), createdPackageJson, { | ||
| spaces: 2, | ||
| }); |
| const ignoredAnswers = ignoredArgs.map((argName) => questions[argName]?.name); | ||
| const standardArgs = ['_', '$0', 'name']; | ||
|
|
||
| const filteredAnswers = Object.fromEntries( |
There was a problem hiding this comment.
Maybe some name like libraryMetadata to make it more obvious what it is?
| const filteredAnswers = Object.fromEntries( | |
| const libraryMetadata = Object.fromEntries( |
| const standardArgs = ['_', '$0', 'name']; | ||
|
|
||
| const filteredAnswers = Object.fromEntries( | ||
| Object.entries(answers).filter( |
There was a problem hiding this comment.
You can do something like this to have better types and remove ts-expect-error
type AnswerEntries<T extends keyof Answers = keyof Answers> = [
T,
Answers[T],
][];
// ...
Object.entries(answers) as AnswerEntries).filter(| Object.entries(answers).filter( | ||
| ([answer]) => | ||
| !( | ||
| ignoredArgs.includes(answer as ArgName) || |
There was a problem hiding this comment.
The casting here seems incorrect as answer will contain camelcase and here ignoredArgs are kebab-case. This should give a type error.
| 'react-native-version', | ||
| ]; | ||
| const ignoredAnswers = ignoredArgs.map((argName) => questions[argName]?.name); | ||
| const standardArgs = ['_', '$0', 'name']; |
There was a problem hiding this comment.
Maybe lets filter these out even before putting these in Answers so we only have the known keys.
Summary
We need a way to track the project information since we are going to introduce a library upgrade helper. With this PR, when you create a new library using
create-react-native-library, it will automatically save;create-react-native-libraryused to create the projectinto
create-react-native-library.jsonfile at the root.Test plan
create-react-native-librarycreate-react-native-library.jsonfile has been generated at the root of your library