diff --git a/.env b/.env new file mode 100644 index 0000000..3d6d6f7 --- /dev/null +++ b/.env @@ -0,0 +1,2 @@ +REACT_APP_RADAR_NAME=AOE Technology Radar +PUBLIC_URL=/techradar \ No newline at end of file diff --git a/.gitignore b/.gitignore index 31e8640..76c2238 100644 --- a/.gitignore +++ b/.gitignore @@ -1,9 +1,24 @@ +# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. + +# dependencies +/node_modules +/.pnp +.pnp.js + +# testing +/coverage + +# production +/build + +# misc .idea .DS_Store -dist -node_modules -npm-debug.log -yarn-error.log -aoe_technology_radar.iml -build -# bin +.env.local +.env.development.local +.env.test.local +.env.production.local + +npm-debug.log* +yarn-debug.log* +yarn-error.log* diff --git a/.husky/.gitignore b/.husky/.gitignore new file mode 100644 index 0000000..31354ec --- /dev/null +++ b/.husky/.gitignore @@ -0,0 +1 @@ +_ diff --git a/.husky/pre-commit b/.husky/pre-commit new file mode 100644 index 0000000..5a31180 --- /dev/null +++ b/.husky/pre-commit @@ -0,0 +1,4 @@ +#!/bin/sh +. "$(dirname "$0")/_/husky.sh" + +yarn ts:check && yarn lint-staged diff --git a/.lintstagedrc b/.lintstagedrc new file mode 100644 index 0000000..d2cb794 --- /dev/null +++ b/.lintstagedrc @@ -0,0 +1,5 @@ +{ + "*.{json, md, yml, js, ts, tsx}": [ + "prettier --write", + ] +} diff --git a/README.md b/README.md index 6550c34..53416cc 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,33 @@ # AOE Technology Radar - A static site generator for AOE Technology Radar ## Looking for the AOE Tech Radar content? - The repository is now found here: https://github.com/AOEpeople/techradar The AOE Tech radar is deployed here: https://www.aoe.com/techradar/index.html ## Usage for your own radar? - The generator is free to use under Open Source License - in fact there are already some other Radars published based on our Radar and there are also Contributions back. (There is a list of planned features below in case someone wants to contribute :-) -However please be aware: +However, please be aware: * It would be nice to mention in radar that the generator is based on this repository. -* Also when you want to reuse the CSS and Styling: Change the font (it is a licensed font) and the colors (It using AOE CI) +* Also, when you want to reuse the CSS and Styling: Change the font (it is a licensed font) and the colors (It using AOE CI) ## Use and build - Add the tech radar as a dependency ``` yarn add https://github.com/aoepeople/aoe_technology_radar.git ``` +Generate json file based on md files +``` +yarn aoe_technology_radar-generateJson +``` + Build the radar ``` -yarn aoe_technology_radar +yarn aoe_technology_radar-buildRadar ``` Serve @@ -34,30 +35,49 @@ Serve cd build python3 -m http.server 8080 ``` + Then open here: http://localhost:8080 ## Run a prepared static version +In most cases you have the tech radar available at `/techradar`, and for reasons want all correct pages to be accessible. -In most cases you have the techradar available at `/techradar`, and for reasons want all correct pages to be accessable. - -Until this setup improves, you can use the following way to generate the correct techradar: +Until this setup improves, you can use the following way to generate the correct tech radar: ``` -PUBLIC_URL=techradar/ yarn aoe_technology_radar -yarn aoe_technology_radar-static +yarn aoe_technology_radar-generateJson +PUBLIC_URL=/techradar yarn aoe_technology_radar-buildRadar +yarn aoe_technology_radar-createStaticFiles cp -r build techradar ``` (This is rather workaroundish for now, but does the job.) -## Usage +## Customize the tech radar +You can customize the following parts of the tech radar. +### Change title, description and headline +Set the environment variable `REACT_APP_RADAR_NAME`. The default is "AOE Technology Radar". + +### Host the application under a sub path +To host the application under a sub path, set the environment variable `PUBLIC_URL`, e.g. "/techradar". + +### Change the favicon +To change the favicon, create a public folder in your application and put your favicon.ico in it. + +### Change the logo +To change the logo, create a public folder in your application and put your logo.svg in it. +For reference have a look at [public/logo.svg](./public/logo.svg). + +### Change the index.html +To change the index.html, create a public folder in your application and put your index.html in it. +For reference have a look at [public/index.html](./public/index.html). + +## Usage For a new Technology Radar release, create a folder of the release date (YYYY-MM-DD) under `/radar`. In each release folder create a folder for every quadrant and place the items there. ### Maintaining items - The items are written in Markdown format (.md) Each file has a [front-matter](https://github.com/jxson/front-matter) header @@ -88,4 +108,14 @@ The name of the .md file acts as item identifier and may overwrite items with the same name from older releases. If an item is overwritten in a new release, the attributes from the new item are -merged with the old ones and a new history entry is created for that item. +merged with the old ones, and a new history entry is created for that item. + +You can integrate images in your markdown. Put the image files in your public folder and reference them +``` +![nice image](/images/nice-image.png) +``` + +## Development +### Change scripts +If you change one of the scripts in the scripts' folder, you have to compile them to JavaScript. +Therefore, run `yarn build:scripts` and commit the results in dist_scripts. diff --git a/bin/src/config.js b/bin/src/config.js deleted file mode 100644 index a63423d..0000000 --- a/bin/src/config.js +++ /dev/null @@ -1,40 +0,0 @@ -"use strict"; -Object.defineProperty(exports, "__esModule", { value: true }); -exports.assetUrl = exports.isMobileViewport = exports.translate = exports.showEmptyRings = exports.getItemPageNames = exports.rings = exports.quadrants = exports.radarNameShort = exports.radarName = void 0; -exports.radarName = process.env.RADAR_NAME || 'AOE Technology Radar'; -exports.radarNameShort = exports.radarName; -exports.quadrants = [ - 'languages-and-frameworks', - 'methods-and-patterns', - 'platforms-and-aoe-services', - 'tools', -]; -exports.rings = [ - 'all', - 'adopt', - 'trial', - 'assess', - 'hold' -]; -exports.getItemPageNames = (items) => items.map(item => `${item.quadrant}/${item.name}`); -exports.showEmptyRings = false; -const messages = { - 'languages-and-frameworks': 'Languages & Frameworks', - 'methods-and-patterns': 'Methods & Patterns', - 'platforms-and-aoe-services': 'Platforms and Operations', - 'tools': 'Tools', -}; -exports.translate = (key) => (messages[key] || '-'); -function isMobileViewport() { - // return false for server side rendering - if (typeof window == 'undefined') - return false; - const width = window.innerWidth || document.documentElement.clientWidth || document.body.clientWidth; - return width < 1200; -} -exports.isMobileViewport = isMobileViewport; -function assetUrl(file) { - return process.env.PUBLIC_URL + '/' + file; - // return `/techradar/assets/${file}` -} -exports.assetUrl = assetUrl; diff --git a/bin/src/model.js b/bin/src/model.js deleted file mode 100644 index e766b24..0000000 --- a/bin/src/model.js +++ /dev/null @@ -1,18 +0,0 @@ -"use strict"; -Object.defineProperty(exports, "__esModule", { value: true }); -exports.getFirstLetter = exports.groupByFirstLetter = exports.groupByQuadrants = exports.featuredOnly = void 0; -exports.featuredOnly = (items) => items.filter(item => item.featured); -exports.groupByQuadrants = (items) => items.reduce((quadrants, item) => (Object.assign(Object.assign({}, quadrants), { [item.quadrant]: addItemToQuadrant(quadrants[item.quadrant], item) })), {}); -exports.groupByFirstLetter = (items) => { - const index = items.reduce((letterIndex, item) => (Object.assign(Object.assign({}, letterIndex), { [exports.getFirstLetter(item)]: addItemToList(letterIndex[exports.getFirstLetter(item)], item) })), {}); - return Object.keys(index) - .sort() - .map(letter => ({ - letter, - items: index[letter], - })); -}; -const addItemToQuadrant = (quadrant = {}, item) => (Object.assign(Object.assign({}, quadrant), { [item.ring]: addItemToRing(quadrant[item.ring], item) })); -const addItemToList = (list = [], item) => [...list, item]; -const addItemToRing = (ring = [], item) => [...ring, item]; -exports.getFirstLetter = (item) => item.title.substr(0, 1).toUpperCase(); diff --git a/bin/tasks/create-static.js b/bin/tasks/create-static.js deleted file mode 100755 index 0e138f2..0000000 --- a/bin/tasks/create-static.js +++ /dev/null @@ -1,34 +0,0 @@ -#!/usr/bin/env node -"use strict"; -var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) { - function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); } - return new (P || (P = Promise))(function (resolve, reject) { - function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } } - function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } } - function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); } - step((generator = generator.apply(thisArg, _arguments || [])).next()); - }); -}; -Object.defineProperty(exports, "__esModule", { value: true }); -const radar_1 = require("./radar"); -const fs_1 = require("fs"); -const config_1 = require("../src/config"); -(() => __awaiter(void 0, void 0, void 0, function* () { - try { - console.log('starting static'); - const radar = yield radar_1.createRadar(); - fs_1.copyFileSync('build/index.html', 'build/overview.html'); - fs_1.copyFileSync('build/index.html', 'build/help-and-about-tech-radar.html'); - config_1.quadrants.forEach(quadrant => { - fs_1.copyFileSync('build/index.html', 'build/' + quadrant + '.html'); - fs_1.mkdirSync('build/' + quadrant); - }); - radar.items.forEach(item => { - fs_1.copyFileSync('build/index.html', 'build/' + item.quadrant + '/' + item.name + '.html'); - }); - console.log('created static'); - } - catch (e) { - console.error('error:', e); - } -}))(); diff --git a/bin/tasks/file.js b/bin/tasks/file.js deleted file mode 100755 index 8d23a03..0000000 --- a/bin/tasks/file.js +++ /dev/null @@ -1,43 +0,0 @@ -"use strict"; -var __importDefault = (this && this.__importDefault) || function (mod) { - return (mod && mod.__esModule) ? mod : { "default": mod }; -}; -Object.defineProperty(exports, "__esModule", { value: true }); -exports.save = exports.getAllMarkdownFiles = exports.distPath = exports.jsPath = exports.faviconPath = exports.assetsPath = exports.stylesPath = exports.radarPath = exports.relativePath = void 0; -const fs_extra_1 = require("fs-extra"); -const path_1 = __importDefault(require("path")); -const walk_1 = require("walk"); -exports.relativePath = (...relativePath) => ( -// path.resolve(__dirname, '..', ...relativePath) -path_1.default.resolve(...relativePath)); -exports.radarPath = (...pathInSrc) => (exports.relativePath('radar', ...pathInSrc)); -exports.stylesPath = (...pathInSrc) => (exports.relativePath('styles', ...pathInSrc)); -exports.assetsPath = (...pathInSrc) => (exports.relativePath('assets', ...pathInSrc)); -exports.faviconPath = (...pathInSrc) => (exports.relativePath('assets/favicon.ico', ...pathInSrc)); -exports.jsPath = (...pathInSrc) => (exports.relativePath('js', ...pathInSrc)); -exports.distPath = (...pathInDist) => (exports.relativePath('src', ...pathInDist)); -exports.getAllMarkdownFiles = (folder) => (getAllFiles(folder, isMarkdownFile)); -const getAllFiles = (folder, predicate) => (new Promise((resolve, reject) => { - const walker = walk_1.walk(folder, { followLinks: false }); - const files = []; - walker.on("file", (root, fileStat, next) => { - if (predicate(fileStat.name)) { - files.push(path_1.default.resolve(root, fileStat.name)); - } - next(); - }); - walker.on("errors", (root, nodeStatsArray, next) => { - nodeStatsArray.forEach(function (n) { - console.error("[ERROR] " + n.name); - if (n.error) { - console.error(n.error.message || (n.error.code + ": " + n.error.path)); - } - }); - next(); - }); - walker.on("end", () => { - resolve(files.sort()); - }); -})); -const isMarkdownFile = (name) => name.match(/\.md$/) !== null; -exports.save = (data, fileName) => fs_extra_1.outputFile(exports.distPath(fileName), data); diff --git a/bin/tasks/radar.js b/bin/tasks/radar.js deleted file mode 100755 index 61d243c..0000000 --- a/bin/tasks/radar.js +++ /dev/null @@ -1,122 +0,0 @@ -"use strict"; -var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) { - function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); } - return new (P || (P = Promise))(function (resolve, reject) { - function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } } - function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } } - function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); } - step((generator = generator.apply(thisArg, _arguments || [])).next()); - }); -}; -var __importDefault = (this && this.__importDefault) || function (mod) { - return (mod && mod.__esModule) ? mod : { "default": mod }; -}; -Object.defineProperty(exports, "__esModule", { value: true }); -exports.createRadar = void 0; -const fs_extra_1 = require("fs-extra"); -const path_1 = __importDefault(require("path")); -const front_matter_1 = __importDefault(require("front-matter")); -const marked_1 = __importDefault(require("marked")); -const highlight_js_1 = __importDefault(require("highlight.js")); -const config_1 = require("../src/config"); -const file_1 = require("./file"); -marked_1.default.setOptions({ - highlight: code => highlight_js_1.default.highlightAuto(code).value, -}); -exports.createRadar = () => __awaiter(void 0, void 0, void 0, function* () { - const fileNames = yield file_1.getAllMarkdownFiles(file_1.radarPath()); - const revisions = yield createRevisionsFromFiles(fileNames); - const allReleases = getAllReleases(revisions); - const items = createItems(revisions); - const flaggedItems = flagItem(items, allReleases); - return { - items: flaggedItems, - releases: allReleases, - }; -}); -const checkAttributes = (fileName, attributes) => { - if (attributes.ring && !config_1.rings.includes(attributes.ring)) { - throw new Error(`Error: ${fileName} has an illegal value for 'ring' - must be one of ${config_1.rings}`); - } - if (attributes.quadrant && !config_1.quadrants.includes(attributes.quadrant)) { - throw new Error(`Error: ${fileName} has an illegal value for 'quadrant' - must be one of ${config_1.quadrants}`); - } - return attributes; -}; -const createRevisionsFromFiles = (fileNames) => Promise.all(fileNames.map(fileName => { - return new Promise((resolve, reject) => { - fs_extra_1.readFile(fileName, 'utf8', (err, data) => { - if (err) { - reject(err); - } - else { - const fm = front_matter_1.default(data); - // add target attribute to external links - // todo: check path - let html = marked_1.default(fm.body.replace(/\]\(\//g, '](/techradar/')); - html = html.replace(/a href="http/g, 'a target="_blank" rel="noopener noreferrer" href="http'); - resolve(Object.assign(Object.assign(Object.assign({}, itemInfoFromFilename(fileName)), checkAttributes(fileName, fm.attributes)), { fileName, body: html })); - } - }); - }); -})); -const itemInfoFromFilename = (fileName) => { - const [release, name] = fileName.split(path_1.default.sep).slice(-2); - return { - name: path_1.default.basename(name, '.md'), - release, - }; -}; -const getAllReleases = (revisions) => revisions - .reduce((allReleases, { release }) => { - if (!allReleases.includes(release)) { - return [...allReleases, release]; - } - return allReleases; -}, []) - .sort(); -const createItems = (revisions) => { - const itemMap = revisions.reduce((items, revision) => { - return Object.assign(Object.assign({}, items), { [revision.name]: addRevisionToItem(items[revision.name], revision) }); - }, {}); - return Object.values(itemMap).map(item => (Object.assign(Object.assign({}, item), { ['title']: item.title || item.name }))).sort((x, y) => (x.name > y.name ? 1 : -1)); -}; -const ignoreEmptyRevisionBody = (revision, item) => { - if (!revision.body || revision.body.trim() === '') { - return item.body; - } - return revision.body; -}; -const addRevisionToItem = (item = { - flag: 'default', - featured: true, - revisions: [], - name: '', - title: '', - ring: 'trial', - quadrant: '', - body: '', - info: '', -}, revision) => { - let newItem = Object.assign(Object.assign(Object.assign({}, item), revision), { body: ignoreEmptyRevisionBody(revision, item) }); - if (revisionCreatesNewHistoryEntry(revision)) { - newItem = Object.assign(Object.assign({}, newItem), { revisions: [revision, ...newItem.revisions] }); - } - return newItem; -}; -const revisionCreatesNewHistoryEntry = (revision) => { - return revision.body.trim() !== '' || typeof revision.ring !== 'undefined'; -}; -const flagItem = (items, allReleases) => items.map(item => (Object.assign(Object.assign({}, item), { flag: getItemFlag(item, allReleases) })), []); -const isInLastRelease = (item, allReleases) => item.revisions[0].release === allReleases[allReleases.length - 1]; -const isNewItem = (item, allReleases) => item.revisions.length === 1 && isInLastRelease(item, allReleases); -const hasItemChanged = (item, allReleases) => item.revisions.length > 1 && isInLastRelease(item, allReleases); -const getItemFlag = (item, allReleases) => { - if (isNewItem(item, allReleases)) { - return 'new'; - } - if (hasItemChanged(item, allReleases)) { - return 'changed'; - } - return 'default'; -}; diff --git a/bin/tasks/radarjson.js b/bin/tasks/radarjson.js deleted file mode 100755 index 847eb1a..0000000 --- a/bin/tasks/radarjson.js +++ /dev/null @@ -1,41 +0,0 @@ -#!/usr/bin/env node -"use strict"; -var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) { - function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); } - return new (P || (P = Promise))(function (resolve, reject) { - function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } } - function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } } - function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); } - step((generator = generator.apply(thisArg, _arguments || [])).next()); - }); -}; -Object.defineProperty(exports, "__esModule", { value: true }); -exports.radarJsonGenerator = void 0; -const radar_1 = require("./radar"); -const file_1 = require("./file"); -exports.radarJsonGenerator = (() => __awaiter(void 0, void 0, void 0, function* () { - try { - console.log('start'); - const radar = yield radar_1.createRadar(); - // console.log(radar); - file_1.save(JSON.stringify(radar), 'rd.json'); - file_1.save(`import React from 'react'; -import ReactDOM from 'react-dom'; -import App from 'aoe_technology_radar/src/components/App'; -import 'aoe_technology_radar/src/index.scss'; -import {Item} from "aoe_technology_radar/src/model"; -import radardata from './rd.json'; - -ReactDOM.render( - - - , - document.getElementById('root') -); -`, 'index.tsx'); - console.log('Built radar'); - } - catch (e) { - console.error('error:', e); - } -})); diff --git a/config/env.js b/config/env.js deleted file mode 100644 index 86630b0..0000000 --- a/config/env.js +++ /dev/null @@ -1,104 +0,0 @@ -'use strict'; - -const fs = require('fs'); -const path = require('path'); -const paths = require('./paths'); - -// Make sure that including paths.js after env.js will read .env variables. -delete require.cache[require.resolve('./paths')]; - -const NODE_ENV = process.env.NODE_ENV; -if (!NODE_ENV) { - throw new Error( - 'The NODE_ENV environment variable is required but was not specified.' - ); -} - -// https://github.com/bkeepers/dotenv#what-other-env-files-can-i-use -const dotenvFiles = [ - `${paths.dotenv}.${NODE_ENV}.local`, - `${paths.dotenv}.${NODE_ENV}`, - // Don't include `.env.local` for `test` environment - // since normally you expect tests to produce the same - // results for everyone - NODE_ENV !== 'test' && `${paths.dotenv}.local`, - paths.dotenv, -].filter(Boolean); - -// Load environment variables from .env* files. Suppress warnings using silent -// if this file is missing. dotenv will never modify any environment variables -// that have already been set. Variable expansion is supported in .env files. -// https://github.com/motdotla/dotenv -// https://github.com/motdotla/dotenv-expand -dotenvFiles.forEach(dotenvFile => { - if (fs.existsSync(dotenvFile)) { - require('dotenv-expand')( - require('dotenv').config({ - path: dotenvFile, - }) - ); - } -}); - -// We support resolving modules according to `NODE_PATH`. -// This lets you use absolute paths in imports inside large monorepos: -// https://github.com/facebook/create-react-app/issues/253. -// It works similar to `NODE_PATH` in Node itself: -// https://nodejs.org/api/modules.html#modules_loading_from_the_global_folders -// Note that unlike in Node, only *relative* paths from `NODE_PATH` are honored. -// Otherwise, we risk importing Node.js core modules into an app instead of webpack shims. -// https://github.com/facebook/create-react-app/issues/1023#issuecomment-265344421 -// We also resolve them to make sure all tools using them work consistently. -const appDirectory = fs.realpathSync(process.cwd()); -process.env.NODE_PATH = (process.env.NODE_PATH || '') - .split(path.delimiter) - .filter(folder => folder && !path.isAbsolute(folder)) - .map(folder => path.resolve(appDirectory, folder)) - .join(path.delimiter); - -// Grab NODE_ENV and REACT_APP_* environment variables and prepare them to be -// injected into the application via DefinePlugin in webpack configuration. -const REACT_APP = /^REACT_APP_/i; - -function getClientEnvironment(publicUrl) { - const raw = Object.keys(process.env) - .filter(key => REACT_APP.test(key)) - .reduce( - (env, key) => { - env[key] = process.env[key]; - return env; - }, - { - // Useful for determining whether we’re running in production mode. - // Most importantly, it switches React into the correct mode. - NODE_ENV: process.env.NODE_ENV || 'development', - // Useful for resolving the correct path to static assets in `public`. - // For example, . - // This should only be used as an escape hatch. Normally you would put - // images into the `src` and `import` them in code to get their paths. - PUBLIC_URL: publicUrl, - - RADAR_NAME: process.env.RADAR_NAME || 'AOE Technology Radar', - - // We support configuring the sockjs pathname during development. - // These settings let a developer run multiple simultaneous projects. - // They are used as the connection `hostname`, `pathname` and `port` - // in webpackHotDevClient. They are used as the `sockHost`, `sockPath` - // and `sockPort` options in webpack-dev-server. - WDS_SOCKET_HOST: process.env.WDS_SOCKET_HOST, - WDS_SOCKET_PATH: process.env.WDS_SOCKET_PATH, - WDS_SOCKET_PORT: process.env.WDS_SOCKET_PORT, - } - ); - // Stringify all values so we can feed into webpack DefinePlugin - const stringified = { - 'process.env': Object.keys(raw).reduce((env, key) => { - env[key] = JSON.stringify(raw[key]); - return env; - }, {}), - }; - - return { raw, stringified }; -} - -module.exports = getClientEnvironment; diff --git a/config/getHttpsConfig.js b/config/getHttpsConfig.js deleted file mode 100644 index 013d493..0000000 --- a/config/getHttpsConfig.js +++ /dev/null @@ -1,66 +0,0 @@ -'use strict'; - -const fs = require('fs'); -const path = require('path'); -const crypto = require('crypto'); -const chalk = require('react-dev-utils/chalk'); -const paths = require('./paths'); - -// Ensure the certificate and key provided are valid and if not -// throw an easy to debug error -function validateKeyAndCerts({ cert, key, keyFile, crtFile }) { - let encrypted; - try { - // publicEncrypt will throw an error with an invalid cert - encrypted = crypto.publicEncrypt(cert, Buffer.from('test')); - } catch (err) { - throw new Error( - `The certificate "${chalk.yellow(crtFile)}" is invalid.\n${err.message}` - ); - } - - try { - // privateDecrypt will throw an error with an invalid key - crypto.privateDecrypt(key, encrypted); - } catch (err) { - throw new Error( - `The certificate key "${chalk.yellow(keyFile)}" is invalid.\n${ - err.message - }` - ); - } -} - -// Read file and throw an error if it doesn't exist -function readEnvFile(file, type) { - if (!fs.existsSync(file)) { - throw new Error( - `You specified ${chalk.cyan( - type - )} in your env, but the file "${chalk.yellow(file)}" can't be found.` - ); - } - return fs.readFileSync(file); -} - -// Get the https config -// Return cert files if provided in env, otherwise just true or false -function getHttpsConfig() { - const { SSL_CRT_FILE, SSL_KEY_FILE, HTTPS } = process.env; - const isHttps = HTTPS === 'true'; - - if (isHttps && SSL_CRT_FILE && SSL_KEY_FILE) { - const crtFile = path.resolve(paths.appPath, SSL_CRT_FILE); - const keyFile = path.resolve(paths.appPath, SSL_KEY_FILE); - const config = { - cert: readEnvFile(crtFile, 'SSL_CRT_FILE'), - key: readEnvFile(keyFile, 'SSL_KEY_FILE'), - }; - - validateKeyAndCerts({ ...config, keyFile, crtFile }); - return config; - } - return isHttps; -} - -module.exports = getHttpsConfig; diff --git a/config/jest/cssTransform.js b/config/jest/cssTransform.js deleted file mode 100644 index 8f65114..0000000 --- a/config/jest/cssTransform.js +++ /dev/null @@ -1,14 +0,0 @@ -'use strict'; - -// This is a custom Jest transformer turning style imports into empty objects. -// http://facebook.github.io/jest/docs/en/webpack.html - -module.exports = { - process() { - return 'module.exports = {};'; - }, - getCacheKey() { - // The output is always the same. - return 'cssTransform'; - }, -}; diff --git a/config/jest/fileTransform.js b/config/jest/fileTransform.js deleted file mode 100644 index aab6761..0000000 --- a/config/jest/fileTransform.js +++ /dev/null @@ -1,40 +0,0 @@ -'use strict'; - -const path = require('path'); -const camelcase = require('camelcase'); - -// This is a custom Jest transformer turning file imports into filenames. -// http://facebook.github.io/jest/docs/en/webpack.html - -module.exports = { - process(src, filename) { - const assetFilename = JSON.stringify(path.basename(filename)); - - if (filename.match(/\.svg$/)) { - // Based on how SVGR generates a component name: - // https://github.com/smooth-code/svgr/blob/01b194cf967347d43d4cbe6b434404731b87cf27/packages/core/src/state.js#L6 - const pascalCaseFilename = camelcase(path.parse(filename).name, { - pascalCase: true, - }); - const componentName = `Svg${pascalCaseFilename}`; - return `const React = require('react'); - module.exports = { - __esModule: true, - default: ${assetFilename}, - ReactComponent: React.forwardRef(function ${componentName}(props, ref) { - return { - $$typeof: Symbol.for('react.element'), - type: 'svg', - ref: ref, - key: null, - props: Object.assign({}, props, { - children: ${assetFilename} - }) - }; - }), - };`; - } - - return `module.exports = ${assetFilename};`; - }, -}; diff --git a/config/modules.js b/config/modules.js deleted file mode 100644 index c8efd0d..0000000 --- a/config/modules.js +++ /dev/null @@ -1,141 +0,0 @@ -'use strict'; - -const fs = require('fs'); -const path = require('path'); -const paths = require('./paths'); -const chalk = require('react-dev-utils/chalk'); -const resolve = require('resolve'); - -/** - * Get additional module paths based on the baseUrl of a compilerOptions object. - * - * @param {Object} options - */ -function getAdditionalModulePaths(options = {}) { - const baseUrl = options.baseUrl; - - // We need to explicitly check for null and undefined (and not a falsy value) because - // TypeScript treats an empty string as `.`. - if (baseUrl == null) { - // If there's no baseUrl set we respect NODE_PATH - // Note that NODE_PATH is deprecated and will be removed - // in the next major release of create-react-app. - - const nodePath = process.env.NODE_PATH || ''; - return nodePath.split(path.delimiter).filter(Boolean); - } - - const baseUrlResolved = path.resolve(paths.appPath, baseUrl); - - // We don't need to do anything if `baseUrl` is set to `node_modules`. This is - // the default behavior. - if (path.relative(paths.appNodeModules, baseUrlResolved) === '') { - return null; - } - - // Allow the user set the `baseUrl` to `appSrc`. - if (path.relative(paths.appSrc, baseUrlResolved) === '') { - return [paths.appSrc]; - } - - // If the path is equal to the root directory we ignore it here. - // We don't want to allow importing from the root directly as source files are - // not transpiled outside of `src`. We do allow importing them with the - // absolute path (e.g. `src/Components/Button.js`) but we set that up with - // an alias. - if (path.relative(paths.appPath, baseUrlResolved) === '') { - return null; - } - - // Otherwise, throw an error. - throw new Error( - chalk.red.bold( - "Your project's `baseUrl` can only be set to `src` or `node_modules`." + - ' Create React App does not support other values at this time.' - ) - ); -} - -/** - * Get webpack aliases based on the baseUrl of a compilerOptions object. - * - * @param {*} options - */ -function getWebpackAliases(options = {}) { - const baseUrl = options.baseUrl; - - if (!baseUrl) { - return {}; - } - - const baseUrlResolved = path.resolve(paths.appPath, baseUrl); - - if (path.relative(paths.appPath, baseUrlResolved) === '') { - return { - src: paths.appSrc, - }; - } -} - -/** - * Get jest aliases based on the baseUrl of a compilerOptions object. - * - * @param {*} options - */ -function getJestAliases(options = {}) { - const baseUrl = options.baseUrl; - - if (!baseUrl) { - return {}; - } - - const baseUrlResolved = path.resolve(paths.appPath, baseUrl); - - if (path.relative(paths.appPath, baseUrlResolved) === '') { - return { - '^src/(.*)$': '/src/$1', - }; - } -} - -function getModules() { - // Check if TypeScript is setup - const hasTsConfig = fs.existsSync(paths.appTsConfig); - const hasJsConfig = fs.existsSync(paths.appJsConfig); - - if (hasTsConfig && hasJsConfig) { - throw new Error( - 'You have both a tsconfig.json and a jsconfig.json. If you are using TypeScript please remove your jsconfig.json file.' - ); - } - - let config; - - // If there's a tsconfig.json we assume it's a - // TypeScript project and set up the config - // based on tsconfig.json - if (hasTsConfig) { - const ts = require(resolve.sync('typescript', { - basedir: paths.appNodeModules, - })); - config = ts.readConfigFile(paths.appTsConfig, ts.sys.readFile).config; - // Otherwise we'll check if there is jsconfig.json - // for non TS projects. - } else if (hasJsConfig) { - config = require(paths.appJsConfig); - } - - config = config || {}; - const options = config.compilerOptions || {}; - - const additionalModulePaths = getAdditionalModulePaths(options); - - return { - additionalModulePaths: additionalModulePaths, - webpackAliases: getWebpackAliases(options), - jestAliases: getJestAliases(options), - hasTsConfig, - }; -} - -module.exports = getModules(); diff --git a/config/paths.js b/config/paths.js deleted file mode 100644 index 74abf0a..0000000 --- a/config/paths.js +++ /dev/null @@ -1,75 +0,0 @@ -'use strict'; - -const path = require('path'); -const fs = require('fs'); -const getPublicUrlOrPath = require('react-dev-utils/getPublicUrlOrPath'); - -// Make sure any symlinks in the project folder are resolved: -// https://github.com/facebook/create-react-app/issues/637 -const appDirectory = fs.realpathSync(process.cwd()); -const resolveApp = relativePath => path.resolve(appDirectory, relativePath); -const templateDirectory = fs.realpathSync(__dirname); -const resolveTemplate = relativePath => path.resolve(templateDirectory, '..', relativePath); - -// We use `PUBLIC_URL` environment variable or "homepage" field to infer -// "public path" at which the app is served. -// webpack needs to know it to put the right