diff --git a/Dockerfile b/Dockerfile index 9cc140608..b542d7617 100644 --- a/Dockerfile +++ b/Dockerfile @@ -9,6 +9,8 @@ ENV PROTOBUF_VERSION=3.9.2 RUN apk add --update --no-cache build-base curl git upx && \ rm -rf /var/cache/apk/* +RUN apk add --update nodejs npm + RUN go get \ github.com/golang/protobuf/protoc-gen-go@v${GOLANG_PROTOBUF_VERSION} &&\ mv /go/bin/protoc-gen-go* /usr/local/bin/ diff --git a/cmd/generate.go b/cmd/generate.go index 979ed1d4e..da717c4ef 100644 --- a/cmd/generate.go +++ b/cmd/generate.go @@ -2,11 +2,11 @@ package cmd import ( "github.com/commitdev/commit0/config" - "github.com/commitdev/commit0/generate/golang" - "github.com/commitdev/commit0/generate/proto" "github.com/commitdev/commit0/generate/docker" + "github.com/commitdev/commit0/generate/golang" "github.com/commitdev/commit0/generate/http" - + "github.com/commitdev/commit0/generate/proto" + "github.com/commitdev/commit0/generate/react" "log" @@ -17,10 +17,11 @@ var configPath string var language string const ( - Go = "go" + Go = "go" + React = "react" ) -var supportedLanguages = [...]string{Go} +var supportedLanguages = [...]string{Go, React} func init() { @@ -42,12 +43,13 @@ var generateCmd = &cobra.Command{ cfg.Language = language cfg.Print() - proto.Generate(Templator, cfg) switch language { case Go: + proto.Generate(Templator, cfg) golang.Generate(Templator, cfg) docker.GenerateGoAppDockerFile(Templator, cfg) - + case React: + react.Generate(Templator, cfg) } if cfg.Network.Http.Enabled { diff --git a/generate/react/generate.go b/generate/react/generate.go new file mode 100644 index 000000000..974f6eef4 --- /dev/null +++ b/generate/react/generate.go @@ -0,0 +1,10 @@ +package react + +import ( + "github.com/commitdev/commit0/config" + "github.com/commitdev/commit0/templator" +) + +func Generate(templator *templator.Templator, config *config.Commit0Config) { + templator.React.TemplateFiles(config, false) +} diff --git a/templates/react/.gitignore b/templates/react/.gitignore new file mode 100644 index 000000000..4d29575de --- /dev/null +++ b/templates/react/.gitignore @@ -0,0 +1,23 @@ +# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. + +# dependencies +/node_modules +/.pnp +.pnp.js + +# testing +/coverage + +# production +/build + +# misc +.DS_Store +.env.local +.env.development.local +.env.test.local +.env.production.local + +npm-debug.log* +yarn-debug.log* +yarn-error.log* diff --git a/templates/react/README.md b/templates/react/README.md new file mode 100644 index 000000000..859d27a64 --- /dev/null +++ b/templates/react/README.md @@ -0,0 +1,68 @@ +This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). + +## 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 the browser. + +The page will reload if you make edits.
+You will 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 + +### Analyzing the Bundle Size + +This section has moved here: 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 + +### Advanced Configuration + +This section has moved here: 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 + +### `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 diff --git a/templates/react/package.json b/templates/react/package.json new file mode 100644 index 000000000..e2bf084fb --- /dev/null +++ b/templates/react/package.json @@ -0,0 +1,31 @@ +{ + "name": "{{ .Name }}", + "version": "0.1.0", + "private": true, + "dependencies": { + "react": "^16.10.2", + "react-dom": "^16.10.2", + "react-scripts": "3.2.0" + }, + "scripts": { + "start": "react-scripts start", + "build": "react-scripts build", + "test": "react-scripts test", + "eject": "react-scripts eject" + }, + "eslintConfig": { + "extends": "react-app" + }, + "browserslist": { + "production": [ + ">0.2%", + "not dead", + "not op_mini all" + ], + "development": [ + "last 1 chrome version", + "last 1 firefox version", + "last 1 safari version" + ] + } +} diff --git a/templates/react/public/favicon.ico b/templates/react/public/favicon.ico new file mode 100644 index 000000000..c2c86b859 Binary files /dev/null and b/templates/react/public/favicon.ico differ diff --git a/templates/react/public/index.html b/templates/react/public/index.html new file mode 100644 index 000000000..c240d2ca8 --- /dev/null +++ b/templates/react/public/index.html @@ -0,0 +1,43 @@ + + + + + + + + + + + + + React App + + + +
+ + + diff --git a/templates/react/public/logo192.png b/templates/react/public/logo192.png new file mode 100644 index 000000000..fa313abf5 Binary files /dev/null and b/templates/react/public/logo192.png differ diff --git a/templates/react/public/logo512.png b/templates/react/public/logo512.png new file mode 100644 index 000000000..bd5d4b5e2 Binary files /dev/null and b/templates/react/public/logo512.png differ diff --git a/templates/react/public/manifest.json b/templates/react/public/manifest.json new file mode 100644 index 000000000..080d6c77a --- /dev/null +++ b/templates/react/public/manifest.json @@ -0,0 +1,25 @@ +{ + "short_name": "React App", + "name": "Create React App Sample", + "icons": [ + { + "src": "favicon.ico", + "sizes": "64x64 32x32 24x24 16x16", + "type": "image/x-icon" + }, + { + "src": "logo192.png", + "type": "image/png", + "sizes": "192x192" + }, + { + "src": "logo512.png", + "type": "image/png", + "sizes": "512x512" + } + ], + "start_url": ".", + "display": "standalone", + "theme_color": "#000000", + "background_color": "#ffffff" +} diff --git a/templates/react/public/robots.txt b/templates/react/public/robots.txt new file mode 100644 index 000000000..01b0f9a10 --- /dev/null +++ b/templates/react/public/robots.txt @@ -0,0 +1,2 @@ +# https://www.robotstxt.org/robotstxt.html +User-agent: * diff --git a/templates/react/src/App.css b/templates/react/src/App.css new file mode 100644 index 000000000..afc388571 --- /dev/null +++ b/templates/react/src/App.css @@ -0,0 +1,22 @@ +.App { + text-align: center; +} + +.App-logo { + height: 40vmin; +} + +.App-header { + background-color: #282c34; + min-height: 100vh; + display: flex; + flex-direction: column; + align-items: center; + justify-content: center; + font-size: calc(10px + 2vmin); + color: white; +} + +.App-link { + color: #09d3ac; +} diff --git a/templates/react/src/App.js b/templates/react/src/App.js new file mode 100644 index 000000000..ce9cbd294 --- /dev/null +++ b/templates/react/src/App.js @@ -0,0 +1,26 @@ +import React from 'react'; +import logo from './logo.svg'; +import './App.css'; + +function App() { + return ( +
+
+ logo +

+ Edit src/App.js and save to reload. +

+ + Learn React + +
+
+ ); +} + +export default App; diff --git a/templates/react/src/App.test.js b/templates/react/src/App.test.js new file mode 100644 index 000000000..a754b201b --- /dev/null +++ b/templates/react/src/App.test.js @@ -0,0 +1,9 @@ +import React from 'react'; +import ReactDOM from 'react-dom'; +import App from './App'; + +it('renders without crashing', () => { + const div = document.createElement('div'); + ReactDOM.render(, div); + ReactDOM.unmountComponentAtNode(div); +}); diff --git a/templates/react/src/index.css b/templates/react/src/index.css new file mode 100644 index 000000000..4a1df4db7 --- /dev/null +++ b/templates/react/src/index.css @@ -0,0 +1,13 @@ +body { + margin: 0; + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", "Oxygen", + "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", + sans-serif; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; +} + +code { + font-family: source-code-pro, Menlo, Monaco, Consolas, "Courier New", + monospace; +} diff --git a/templates/react/src/index.js b/templates/react/src/index.js new file mode 100644 index 000000000..87d1be551 --- /dev/null +++ b/templates/react/src/index.js @@ -0,0 +1,12 @@ +import React from 'react'; +import ReactDOM from 'react-dom'; +import './index.css'; +import App from './App'; +import * as serviceWorker from './serviceWorker'; + +ReactDOM.render(, document.getElementById('root')); + +// If you want your app to work offline and load faster, you can change +// unregister() to register() below. Note this comes with some pitfalls. +// Learn more about service workers: https://bit.ly/CRA-PWA +serviceWorker.unregister(); diff --git a/templates/react/src/logo.svg b/templates/react/src/logo.svg new file mode 100644 index 000000000..2e5df0d3a --- /dev/null +++ b/templates/react/src/logo.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/templates/react/src/serviceWorker.js b/templates/react/src/serviceWorker.js new file mode 100644 index 000000000..f8c7e50c2 --- /dev/null +++ b/templates/react/src/serviceWorker.js @@ -0,0 +1,135 @@ +// This optional code is used to register a service worker. +// register() is not called by default. + +// This lets the app load faster on subsequent visits in production, and gives +// it offline capabilities. However, it also means that developers (and users) +// will only see deployed updates on subsequent visits to a page, after all the +// existing tabs open on the page have been closed, since previously cached +// resources are updated in the background. + +// To learn more about the benefits of this model and instructions on how to +// opt-in, read https://bit.ly/CRA-PWA + +const isLocalhost = Boolean( + window.location.hostname === 'localhost' || + // [::1] is the IPv6 localhost address. + window.location.hostname === '[::1]' || + // 127.0.0.1/8 is considered localhost for IPv4. + window.location.hostname.match( + /^127(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}$/ + ) +); + +export function register(config) { + if (process.env.NODE_ENV === 'production' && 'serviceWorker' in navigator) { + // The URL constructor is available in all browsers that support SW. + const publicUrl = new URL(process.env.PUBLIC_URL, window.location.href); + if (publicUrl.origin !== window.location.origin) { + // Our service worker won't work if PUBLIC_URL is on a different origin + // from what our page is served on. This might happen if a CDN is used to + // serve assets; see https://github.com/facebook/create-react-app/issues/2374 + return; + } + + window.addEventListener('load', () => { + const swUrl = `${process.env.PUBLIC_URL}/service-worker.js`; + + if (isLocalhost) { + // This is running on localhost. Let's check if a service worker still exists or not. + checkValidServiceWorker(swUrl, config); + + // Add some additional logging to localhost, pointing developers to the + // service worker/PWA documentation. + navigator.serviceWorker.ready.then(() => { + console.log( + 'This web app is being served cache-first by a service ' + + 'worker. To learn more, visit https://bit.ly/CRA-PWA' + ); + }); + } else { + // Is not localhost. Just register service worker + registerValidSW(swUrl, config); + } + }); + } +} + +function registerValidSW(swUrl, config) { + navigator.serviceWorker + .register(swUrl) + .then(registration => { + registration.onupdatefound = () => { + const installingWorker = registration.installing; + if (installingWorker == null) { + return; + } + installingWorker.onstatechange = () => { + if (installingWorker.state === 'installed') { + if (navigator.serviceWorker.controller) { + // At this point, the updated precached content has been fetched, + // but the previous service worker will still serve the older + // content until all client tabs are closed. + console.log( + 'New content is available and will be used when all ' + + 'tabs for this page are closed. See https://bit.ly/CRA-PWA.' + ); + + // Execute callback + if (config && config.onUpdate) { + config.onUpdate(registration); + } + } else { + // At this point, everything has been precached. + // It's the perfect time to display a + // "Content is cached for offline use." message. + console.log('Content is cached for offline use.'); + + // Execute callback + if (config && config.onSuccess) { + config.onSuccess(registration); + } + } + } + }; + }; + }) + .catch(error => { + console.error('Error during service worker registration:', error); + }); +} + +function checkValidServiceWorker(swUrl, config) { + // Check if the service worker can be found. If it can't reload the page. + fetch(swUrl) + .then(response => { + // Ensure service worker exists, and that we really are getting a JS file. + const contentType = response.headers.get('content-type'); + if ( + response.status === 404 || + (contentType != null && contentType.indexOf('javascript') === -1) + ) { + // No service worker found. Probably a different app. Reload the page. + navigator.serviceWorker.ready.then(registration => { + registration.unregister().then(() => { + window.location.reload(); + }); + }); + } else { + // Service worker found. Proceed as normal. + registerValidSW(swUrl, config); + } + }) + .catch(() => { + console.log( + 'No internet connection found. App is running in offline mode.' + ); + }); +} + +export function unregister() { + if ('serviceWorker' in navigator) { + navigator.serviceWorker.ready.then(registration => { + registration.unregister(); + }); + } +} diff --git a/templator/templator.go b/templator/templator.go index 8e8b78fff..9c2050ed7 100644 --- a/templator/templator.go +++ b/templator/templator.go @@ -1,15 +1,19 @@ package templator import ( + "path/filepath" + "text/template" + + "github.com/commitdev/commit0/config" "github.com/commitdev/commit0/util" "github.com/gobuffalo/packr/v2" - "text/template" + "github.com/gobuffalo/packr/v2/file" ) type DockerTemplator struct { ApplicationDocker *template.Template HttpGatewayDocker *template.Template - DockerIgnore *template.Template + DockerIgnore *template.Template } type GoTemplator struct { @@ -29,6 +33,7 @@ type Templator struct { ProtoServiceTemplate *template.Template Go *GoTemplator Docker *DockerTemplator + React *DirectoryTemplator } func NewTemplator(box *packr.Box) *Templator { @@ -46,9 +51,10 @@ func NewTemplator(box *packr.Box) *Templator { ProtoHealthTemplate: protoHealthTemplate, ProtoServiceTemplate: protoServiceTemplate, Go: NewGoTemplator(box), - Commit0: NewCommit0Templator(box), + Commit0: NewCommit0Templator(box), GitIgnore: NewGitIgnoreTemplator(box), Docker: NewDockerFileTemplator(box), + React: NewDirectoryTemplator(box, "react"), } } @@ -108,6 +114,48 @@ func NewDockerFileTemplator(box *packr.Box) *DockerTemplator { return &DockerTemplator{ ApplicationDocker: appTemplate, HttpGatewayDocker: httpTemplate, - DockerIgnore: ignoreTemplate, + DockerIgnore: ignoreTemplate, + } +} + +type DirectoryTemplator struct { + Templates []*template.Template +} + +func (d *DirectoryTemplator) TemplateFiles(config *config.Commit0Config, overwrite bool) { + for _, template := range d.Templates { + d, f := filepath.Split(template.Name()) + if overwrite { + util.TemplateFileAndOverwrite(d, f, template, config) + } else { + util.TemplateFileIfDoesNotExist(d, f, template, config) + } + } +} + +func NewDirectoryTemplator(box *packr.Box, dir string) *DirectoryTemplator { + templates := []*template.Template{} + for _, file := range getFileNames(box, dir) { + templateSource, _ := box.FindString(file) + template, _ := template.New(file).Funcs(util.FuncMap).Parse(templateSource) + templates = append(templates, template) } + return &DirectoryTemplator{ + Templates: templates, + } +} + +func getFileNames(box *packr.Box, dir string) []string { + keys := []string{} + box.WalkPrefix(dir, func(path string, info file.File) error { + if info == nil { + return nil + } + finfo, _ := info.FileInfo() + if !finfo.IsDir() { + keys = append(keys, path) + } + return nil + }) + return keys } diff --git a/util/util.go b/util/util.go index 0b061c522..757f830a5 100644 --- a/util/util.go +++ b/util/util.go @@ -1,10 +1,10 @@ package util import ( - "os" - "strings" "fmt" "log" + "os" + "strings" "text/template" ) @@ -31,7 +31,6 @@ func createTemplatedFile(fullFilePath string, template *template.Template, data } } - func TemplateFileAndOverwrite(fileDir string, fileName string, template *template.Template, data interface{}) { fullFilePath := fmt.Sprintf("%v/%v", fileDir, fileName) err := os.MkdirAll(fileDir, os.ModePerm)