-
Notifications
You must be signed in to change notification settings - Fork 7
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
Proof of Concept: [UIAPPS-177] add cra-template packages for starter-kit #127
Draft
ericrallen
wants to merge
3
commits into
master
Choose a base branch
from
feature/create-react-app-template
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,34 +1,34 @@ | ||
| { | ||
| "name": "@datadog/cra-template-apps-starter-kit", | ||
| "version": "1.0.0", | ||
| "keywords": [ | ||
| "react", | ||
| "create-react-app", | ||
| "template", | ||
| "datadog" | ||
| ], | ||
| "description": "Datadog UI Apps Starter Kit", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "git+https://github.com/DataDog/apps.git", | ||
| "directory": "packages/cra-template-apps-starter-kit" | ||
| }, | ||
| "license": "Apache-2.0", | ||
| "engines": { | ||
| "node": ">=16" | ||
| }, | ||
| "bugs": { | ||
| "url": "https://github.com/DataDog/apps/issues" | ||
| }, | ||
| "main": "template.json", | ||
| "files": [ | ||
| "template", | ||
| "template.json" | ||
| ], | ||
| "publishConfig": { | ||
| "access": "public" | ||
| }, | ||
| "scripts": { | ||
| "prepare": "exit 0" | ||
| } | ||
| "name": "@datadog/cra-template-apps-starter-kit", | ||
| "version": "1.0.0", | ||
| "keywords": [ | ||
| "react", | ||
| "create-react-app", | ||
| "template", | ||
| "datadog" | ||
| ], | ||
| "description": "Datadog UI Apps Starter Kit", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "git+https://github.com/DataDog/apps.git", | ||
| "directory": "packages/cra-template-apps-starter-kit" | ||
| }, | ||
| "license": "Apache-2.0", | ||
| "engines": { | ||
| "node": ">=16" | ||
| }, | ||
| "bugs": { | ||
| "url": "https://github.com/DataDog/apps/issues" | ||
| }, | ||
| "main": "template.json", | ||
| "files": [ | ||
| "template", | ||
| "template.json" | ||
| ], | ||
| "publishConfig": { | ||
| "access": "public" | ||
| }, | ||
| "scripts": { | ||
| "prepare": "exit 0" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,27 +1,21 @@ | ||
| { | ||
| "package": { | ||
| "dependencies": { | ||
| "@datadog/ui-extensions-react": "0.30.1", | ||
| "@datadog/ui-extensions-sdk": "0.30.1", | ||
| "milligram": "^1.4.1", | ||
| "react": "^17.0.2", | ||
| "react-dom": "^17.0.2", | ||
| "typeface-roboto": "^1.1.13" | ||
| }, | ||
| "eslintConfig": { | ||
| "extends": ["react-app", "react-app/jest"] | ||
| }, | ||
| "browserslist": { | ||
| "production": [ | ||
| ">0.2%", | ||
| "not dead", | ||
| "not op_mini all" | ||
| ], | ||
| "development": [ | ||
| "last 1 chrome version", | ||
| "last 1 firefox version", | ||
| "last 1 safari version" | ||
| ] | ||
| "package": { | ||
| "dependencies": { | ||
| "@datadog/ui-extensions-react": "0.31.0", | ||
| "@datadog/ui-extensions-sdk": "0.31.0", | ||
| "milligram": "^1.4.1", | ||
| "typeface-roboto": "^1.1.13" | ||
| }, | ||
| "eslintConfig": { | ||
| "extends": ["react-app", "react-app/jest"] | ||
| }, | ||
| "browserslist": { | ||
| "production": [">0.2%", "not dead", "not op_mini all"], | ||
| "development": [ | ||
| "last 1 chrome version", | ||
| "last 1 firefox version", | ||
| "last 1 safari version" | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| # Datadog UI App React Starter Kit | ||
|
|
||
| This project was generated via the [Datadog UI Apps Starter Kit](https://github.com/datadog/apps/packages/cra-template-apps-starter-kit) [`create-react-app`](https://create-react-app.dev/) [custom template](https://create-react-app.dev/docs/custom-templates). | ||
|
|
||
| ## Available Scripts | ||
|
|
||
| In the project directory, you can run: | ||
|
|
||
| ### `npm start` | ||
|
|
||
| Runs the app in the development mode.\ | ||
| Open [http://localhost:3000](http://localhost:3000) to view it in your browser. | ||
|
|
||
| The page will reload when you make changes.\ | ||
| You may also see any lint errors in the console. | ||
|
|
||
| ### `npm test` | ||
|
|
||
| Launches the test runner in the interactive watch mode.\ | ||
| See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. | ||
|
|
||
| ### `npm run build` | ||
|
|
||
| Builds the app for production to the `build` folder.\ | ||
| It correctly bundles React in production mode and optimizes the build for the best performance. | ||
|
|
||
| The build is minified and the filenames include the hashes.\ | ||
| Your app is ready to be deployed! | ||
|
|
||
| See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. | ||
|
|
||
| ### `npm run eject` | ||
|
|
||
| **Note: this is a one-way operation. Once you `eject`, you can't go back!** | ||
|
|
||
| If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. | ||
|
|
||
| Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own. | ||
|
|
||
| You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it. | ||
|
|
||
| ## Learn More | ||
|
|
||
| You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). | ||
|
|
||
| To learn React, check out the [React documentation](https://reactjs.org/). | ||
|
|
||
| ### Code Splitting | ||
|
|
||
| This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting) | ||
|
|
||
| ### Analyzing the Bundle Size | ||
|
|
||
| This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size) | ||
|
|
||
| ### Making a Progressive Web App | ||
|
|
||
| This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app) | ||
|
|
||
| ### Advanced Configuration | ||
|
|
||
| This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration) | ||
|
|
||
| ### Deployment | ||
|
|
||
| This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment) | ||
|
|
||
| ### `npm run build` fails to minify | ||
|
|
||
| This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify) |
66 changes: 33 additions & 33 deletions
66
packages/cra-template-apps-typescript-starter-kit/package.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,35 +1,35 @@ | ||
| { | ||
| "name": "@datadog/cra-template-apps-typescript-starter-kit", | ||
| "version": "1.0.0", | ||
| "keywords": [ | ||
| "react", | ||
| "create-react-app", | ||
| "template", | ||
| "typescript", | ||
| "datadog" | ||
| ], | ||
| "description": "Datadog UI Apps Starter Kit", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "git+https://github.com/DataDog/apps.git", | ||
| "directory": "packages/cra-template-apps-typescript-starter-kit" | ||
| }, | ||
| "license": "Apache-2.0", | ||
| "engines": { | ||
| "node": ">=16" | ||
| }, | ||
| "bugs": { | ||
| "url": "https://github.com/DataDog/apps/issues" | ||
| }, | ||
| "main": "template.json", | ||
| "files": [ | ||
| "template", | ||
| "template.json" | ||
| ], | ||
| "publishConfig": { | ||
| "access": "public" | ||
| }, | ||
| "scripts": { | ||
| "prepare": "exit 0" | ||
| } | ||
| "name": "@datadog/cra-template-apps-typescript-starter-kit", | ||
| "version": "1.0.0", | ||
| "keywords": [ | ||
| "react", | ||
| "create-react-app", | ||
| "template", | ||
| "typescript", | ||
| "datadog" | ||
| ], | ||
| "description": "Datadog UI Apps Starter Kit", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "git+https://github.com/DataDog/apps.git", | ||
| "directory": "packages/cra-template-apps-typescript-starter-kit" | ||
| }, | ||
| "license": "Apache-2.0", | ||
| "engines": { | ||
| "node": ">=16" | ||
| }, | ||
| "bugs": { | ||
| "url": "https://github.com/DataDog/apps/issues" | ||
| }, | ||
| "main": "template.json", | ||
| "files": [ | ||
| "template", | ||
| "template.json" | ||
| ], | ||
| "publishConfig": { | ||
| "access": "public" | ||
| }, | ||
| "scripts": { | ||
| "prepare": "exit 0" | ||
| } | ||
| } |
52 changes: 22 additions & 30 deletions
52
packages/cra-template-apps-typescript-starter-kit/template.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,33 +1,25 @@ | ||
| { | ||
| "package": { | ||
| "dependencies": { | ||
| "@datadog/ui-extensions-react": "0.30.1", | ||
| "@datadog/ui-extensions-sdk": "0.30.1", | ||
| "milligram": "^1.4.1", | ||
| "react": "^17.0.2", | ||
| "react-dom": "^17.0.2", | ||
| "typeface-roboto": "^1.1.13" | ||
| }, | ||
| "devDependencies": { | ||
| "@types/node": "^16.7.13", | ||
| "@types/react": "^17.0.43", | ||
| "@types/react-dom": "^17.0.14", | ||
| "typescript": "^4.4.2" | ||
| }, | ||
| "eslintConfig": { | ||
| "extends": ["react-app", "react-app/jest"] | ||
| }, | ||
| "browserslist": { | ||
| "production": [ | ||
| ">0.2%", | ||
| "not dead", | ||
| "not op_mini all" | ||
| ], | ||
| "development": [ | ||
| "last 1 chrome version", | ||
| "last 1 firefox version", | ||
| "last 1 safari version" | ||
| ] | ||
| "package": { | ||
| "dependencies": { | ||
| "@datadog/ui-extensions-react": "0.31.0", | ||
| "@datadog/ui-extensions-sdk": "0.31.0", | ||
| "@types/node": "^16.7.13", | ||
| "@types/react": "^17.0.43", | ||
| "@types/react-dom": "^17.0.14", | ||
| "milligram": "^1.4.1", | ||
| "typeface-roboto": "^1.1.13", | ||
| "typescript": "^4.4.2" | ||
| }, | ||
| "eslintConfig": { | ||
| "extends": ["react-app", "react-app/jest"] | ||
| }, | ||
| "browserslist": { | ||
| "production": [">0.2%", "not dead", "not op_mini all"], | ||
| "development": [ | ||
| "last 1 chrome version", | ||
| "last 1 firefox version", | ||
| "last 1 safari version" | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| } |
70 changes: 70 additions & 0 deletions
70
packages/cra-template-apps-typescript-starter-kit/template/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| # Datadog UI App TypeScript+React Starter Kit | ||
|
|
||
| This project was generated via the [Datadog UI Apps TypeScript Starter Kit](https://github.com/datadog/apps/packages/cra-template-apps-typescript-starter-kit) [`create-react-app`](https://create-react-app.dev/) [custom template](https://create-react-app.dev/docs/custom-templates). | ||
|
|
||
| ## Available Scripts | ||
|
|
||
| In the project directory, you can run: | ||
|
|
||
| ### `npm start` | ||
|
|
||
| Runs the app in the development mode.\ | ||
| Open [http://localhost:3000](http://localhost:3000) to view it in your browser. | ||
|
|
||
| The page will reload when you make changes.\ | ||
| You may also see any lint errors in the console. | ||
|
|
||
| ### `npm test` | ||
|
|
||
| Launches the test runner in the interactive watch mode.\ | ||
| See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. | ||
|
|
||
| ### `npm run build` | ||
|
|
||
| Builds the app for production to the `build` folder.\ | ||
| It correctly bundles React in production mode and optimizes the build for the best performance. | ||
|
|
||
| The build is minified and the filenames include the hashes.\ | ||
| Your app is ready to be deployed! | ||
|
|
||
| See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. | ||
|
|
||
| ### `npm run eject` | ||
|
|
||
| **Note: this is a one-way operation. Once you `eject`, you can't go back!** | ||
|
|
||
| If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. | ||
|
|
||
| Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own. | ||
|
|
||
| You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it. | ||
|
|
||
| ## Learn More | ||
|
|
||
| You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). | ||
|
|
||
| To learn React, check out the [React documentation](https://reactjs.org/). | ||
|
|
||
| ### Code Splitting | ||
|
|
||
| This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting) | ||
|
|
||
| ### Analyzing the Bundle Size | ||
|
|
||
| This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size) | ||
|
|
||
| ### Making a Progressive Web App | ||
|
|
||
| This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app) | ||
|
|
||
| ### Advanced Configuration | ||
|
|
||
| This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration) | ||
|
|
||
| ### Deployment | ||
|
|
||
| This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment) | ||
|
|
||
| ### `npm run build` fails to minify | ||
|
|
||
| This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
❓ question: Can we think through how we might keep these versions in sync with the actual versions in the respective packages? Does CRA have some tooling or a pattern for that?
The way it currently works for the other workspaces is that the version gets bumped whenever we make a release. This works because
changesetssees one of these@datadog/ui-extensions-*packages version changes and goes and updates all of the dependencies each workspace. That doesn't need to be the only way we do things, it's just how we've done it so far.The only other place in the repo that's not always in sync is the
packages/create-app/src/template/package.jsonfile. Sincepackages/create-app/src/templateisn't a workspace, it doesn't get the auto-update fromchangesets. Only reason that is the way it is is neglect: we missed that when adding the template feature. So in that regard, adding the CRA templates is no different than what we have now. But, if we could it'd be nice to figure out a way to make it automatically update.Barring an automatic update, we could throw a script together that checked these versions matched the expected version and run it as part of
yarn test. We do that with other things we can't easily automate away. That way at least we get a failure, even if a human has to get involved.In any case, more than happy to spit ball some ideas you might have. And this isn't blocking, so don't worry if there isn't really a good story here. Just wanted to bring it up in case there was something.