From ac5bd9ef36e6088ccc945cdab24b4b8e60d43a72 Mon Sep 17 00:00:00 2001 From: Valentin Sarychev Date: Sat, 3 Oct 2020 23:33:56 +0300 Subject: [PATCH 1/3] feat: add --check option --- package-lock.json | 21 ++++++++++++++++ package.json | 3 +++ src/cli/build.ts | 57 +++++++++++++++++++++++++++++++++++++++-- tsconfig.json | 64 ++++++----------------------------------------- 4 files changed, 87 insertions(+), 58 deletions(-) diff --git a/package-lock.json b/package-lock.json index 126e819..8712e2b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -4762,6 +4762,11 @@ "universalify": "^0.1.0" } }, + "fs-monkey": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/fs-monkey/-/fs-monkey-1.0.1.tgz", + "integrity": "sha512-fcSa+wyTqZa46iWweI7/ZiUfegOZl0SG8+dltIwFXo7+zYU9J9kpS3NB6pZcSlJdhvIwp81Adx2XhZorncxiaA==" + }, "fs.realpath": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", @@ -8096,6 +8101,14 @@ "object-visit": "^1.0.0" } }, + "memfs": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/memfs/-/memfs-3.2.0.tgz", + "integrity": "sha512-f/xxz2TpdKv6uDn6GtHee8ivFyxwxmPuXatBb1FBwxYNuVpbM3k/Y1Z+vC0mH/dIXXrukYfe3qe5J32Dfjg93A==", + "requires": { + "fs-monkey": "1.0.1" + } + }, "meow": { "version": "7.1.0", "resolved": "https://registry.npmjs.org/meow/-/meow-7.1.0.tgz", @@ -10541,6 +10554,14 @@ "set-value": "^2.0.1" } }, + "unionfs": { + "version": "4.4.0", + "resolved": "https://registry.npmjs.org/unionfs/-/unionfs-4.4.0.tgz", + "integrity": "sha512-N+TuJHJ3PjmzIRCE1d2N3VN4qg/P78eh/nxzwHnzpg3W2Mvf8Wvi7J1mvv6eNkb8neUeSdFSQsKna0eXVyF4+w==", + "requires": { + "fs-monkey": "^1.0.0" + } + }, "universalify": { "version": "0.1.2", "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz", diff --git a/package.json b/package.json index a35ac26..af8c259 100644 --- a/package.json +++ b/package.json @@ -39,9 +39,12 @@ "deepmerge": "4.2.2", "fast-glob": "3.2.2", "fs-extra": "8.1.0", + "fs-monkey": "^1.0.1", + "memfs": "^3.2.0", "normalize-path": "3.0.0", "read-pkg-up": "7.0.1", "style-dictionary": "2.10.0", + "unionfs": "^4.4.0", "yaml": "1.10.0" }, "devDependencies": { diff --git a/src/cli/build.ts b/src/cli/build.ts index 4289ad7..904a0f9 100644 --- a/src/cli/build.ts +++ b/src/cli/build.ts @@ -1,9 +1,13 @@ +import { dirname, relative } from 'path' +import { Union } from 'unionfs' +import { Volume } from 'memfs' +import * as fs from 'fs-extra' import { resolve } from 'path' import { Command, flags } from '@oclif/command' import { watch } from 'chokidar' import chalk from 'chalk' -import { loadConfig } from '../core/config' +import { Config, loadConfig } from '../core/config' import { build } from '../core/build' import { loadTheme } from '../core/load-theme' import { debounce, flatten } from '../core/utils' @@ -13,6 +17,7 @@ type Flags = { watch: boolean entry: string[] output: string[] + check: boolean } export default class Build extends Command { @@ -38,6 +43,10 @@ export default class Build extends Command { multiple: true, description: 'Builds selected outputs.', }), + check: flags.boolean({ + description: 'Checks output files will not be modified on build', + default: false, + }), } async run() { @@ -47,6 +56,10 @@ export default class Build extends Command { outputs: flags.output, }) + if (flags.check) { + return this.check(config) + } + await this.build(config) if (flags.watch) { @@ -85,12 +98,52 @@ export default class Build extends Command { } } - private async build(config: any) { + private async build(config: Config) { console.log(`----------------- ${chalk.yellow('Build started')} -----------------`) await build(config) console.log(`\n---------------- ${chalk.green('Build completed')} ----------------`) } + private async check(config: Config) { + const memfs = Volume.fromJSON({}) + const ufs = new Union().use(fs as any).use(memfs as any) + + // workaround https://github.com/streamich/unionfs/issues/425 + const { openSync } = ufs + ufs.openSync = function(this, path) { + if (typeof path === 'string') { + memfs.mkdirpSync(dirname(path)) + } + return openSync.apply(this, arguments as any) + } + + const unpatchFsExtra = require('fs-monkey').patchFs(ufs, require('fs-extra')) + const unpatchFs = require('fs-monkey').patchFs(ufs) + try { + await build(config) + } finally { + unpatchFsExtra() + unpatchFs() + } + + let failed = false + const files = memfs.toJSON() + + for (const [fileName, fileContent] of Object.entries(files)) { + if (fileContent) { + const fileOldContent = fs.readFileSync(fileName, 'utf8') + if (fileOldContent !== fileContent) { + failed = true + console.log(chalk.red(`${relative(process.cwd(), fileName)} is outdated`)) + } + } + } + + if (failed) { + throw 'failed' + } + } + private emitWatching() { console.log('\nWatching for changes...') } diff --git a/tsconfig.json b/tsconfig.json index a6b77c3..621bd12 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -1,62 +1,14 @@ { "compilerOptions": { - /* Basic Options */ - "target": "ESNext" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */, - "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */, - // "lib": [], /* Specify library files to be included in the compilation. */ - // "allowJs": true, /* Allow javascript files to be compiled. */ - // "checkJs": true, /* Report errors in .js files. */ - // "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */ - "declaration": true /* Generates corresponding '.d.ts' file. */, - // "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */ - // "sourceMap": true, /* Generates corresponding '.map' file. */ - // "outFile": "./", /* Concatenate and emit output to single file. */ - "outDir": "./lib" /* Redirect output structure to the directory. */, - "rootDir": "./src" /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */, - // "composite": true, /* Enable project compilation */ - // "removeComments": true, /* Do not emit comments to output. */ - // "noEmit": true, /* Do not emit outputs. */ - // "importHelpers": true, /* Import emit helpers from 'tslib'. */ - // "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */ - // "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */ + "target": "es6", + "module": "commonjs", + "declaration": true, + "outDir": "./lib", + "rootDir": "./src", "stripInternal": true, - - /* Strict Type-Checking Options */ - "strict": true /* Enable all strict type-checking options. */, - // "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */ - // "strictNullChecks": true, /* Enable strict null checks. */ - // "strictFunctionTypes": true, /* Enable strict checking of function types. */ - // "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */ - // "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */ - // "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */ - // "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */ - - /* Additional Checks */ - // "noUnusedLocals": true, /* Report errors on unused locals. */ - // "noUnusedParameters": true, /* Report errors on unused parameters. */ - // "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */ - // "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */ - - /* Module Resolution Options */ - // "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */ - // "baseUrl": "./", /* Base directory to resolve non-absolute module names. */ - // "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */ - // "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */ - // "typeRoots": [], /* List of folders to include type definitions from. */ - // "types": [], /* Type declaration files to be included in compilation. */ - "allowSyntheticDefaultImports": true /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */, - "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */ - // "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */ - - /* Source Map Options */ - // "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */ - // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ - // "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */ - // "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */ - - /* Experimental Options */ - // "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */ - // "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */ + "strict": true, + "allowSyntheticDefaultImports": true, + "esModuleInterop": true }, "include": ["src"] } From 4352ca47ec02a8e11e45fa4505035c2d7de70fff Mon Sep 17 00:00:00 2001 From: Valentin Sarychev Date: Sun, 4 Oct 2020 22:36:42 +0300 Subject: [PATCH 2/3] fixup! feat: add --check option normalize CSS --- package-lock.json | 25 +++++++++++++++++++++++-- package.json | 1 + src/cli/build.ts | 15 ++++++++++++--- src/core/utils.ts | 6 ++++++ 4 files changed, 42 insertions(+), 5 deletions(-) diff --git a/package-lock.json b/package-lock.json index 8712e2b..c3fa597 100644 --- a/package-lock.json +++ b/package-lock.json @@ -3842,6 +3842,23 @@ } } }, + "css-tree": { + "version": "1.0.0-alpha.39", + "resolved": "https://registry.npmjs.org/css-tree/-/css-tree-1.0.0-alpha.39.tgz", + "integrity": "sha512-7UvkEYgBAHRG9Nt980lYxjsTrCyHFN53ky3wVsDkiMdVqylqRt+Zc+jm5qw7/qyOvN2dHSYtX0e4MbCCExSvnA==", + "requires": { + "mdn-data": "2.0.6", + "source-map": "^0.6.1" + } + }, + "csso": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/csso/-/csso-4.0.3.tgz", + "integrity": "sha512-NL3spysxUkcrOgnpsT4Xdl2aiEiBG6bXswAABQVHcMrfjjBisFOKwLDOmf4wf32aPdcJws1zds2B0Rg+jqMyHQ==", + "requires": { + "css-tree": "1.0.0-alpha.39" + } + }, "cssom": { "version": "0.4.4", "resolved": "https://registry.npmjs.org/cssom/-/cssom-0.4.4.tgz", @@ -8101,6 +8118,11 @@ "object-visit": "^1.0.0" } }, + "mdn-data": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/mdn-data/-/mdn-data-2.0.6.tgz", + "integrity": "sha512-rQvjv71olwNHgiTbfPZFkJtjNMciWgswYeciZhtvWLO8bmX3TnhyA62I6sTWOyZssWHJJjY6/KiWwqQsWWsqOA==" + }, "memfs": { "version": "3.2.0", "resolved": "https://registry.npmjs.org/memfs/-/memfs-3.2.0.tgz", @@ -9740,8 +9762,7 @@ "source-map": { "version": "0.6.1", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", - "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", - "dev": true + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==" }, "source-map-resolve": { "version": "0.5.3", diff --git a/package.json b/package.json index af8c259..8a993d4 100644 --- a/package.json +++ b/package.json @@ -36,6 +36,7 @@ "chalk": "4.1.0", "chokidar": "3.4.0", "css-color-function": "1.3.3", + "csso": "^4.0.3", "deepmerge": "4.2.2", "fast-glob": "3.2.2", "fs-extra": "8.1.0", diff --git a/src/cli/build.ts b/src/cli/build.ts index 904a0f9..4f55a33 100644 --- a/src/cli/build.ts +++ b/src/cli/build.ts @@ -10,7 +10,7 @@ import chalk from 'chalk' import { Config, loadConfig } from '../core/config' import { build } from '../core/build' import { loadTheme } from '../core/load-theme' -import { debounce, flatten } from '../core/utils' +import { debounce, flatten, normalizeCss } from '../core/utils' type Flags = { config: string @@ -131,10 +131,19 @@ export default class Build extends Command { for (const [fileName, fileContent] of Object.entries(files)) { if (fileContent) { + if (!fs.existsSync(fileName)) { + console.log(chalk.red(`${relative(process.cwd(), fileName)} doesn't exist`)) + continue + } const fileOldContent = fs.readFileSync(fileName, 'utf8') - if (fileOldContent !== fileContent) { + if (fileName.endsWith('.css')) { + if (normalizeCss(fileContent) !== normalizeCss(fileOldContent)) { + failed = true + console.log(chalk.red(`${relative(process.cwd(), fileName)} (CSS file) is outdated`)) + } + } else if (fileContent !== fileOldContent) { failed = true - console.log(chalk.red(`${relative(process.cwd(), fileName)} is outdated`)) + console.log(chalk.red(`${relative(process.cwd(), fileName)} (text file) is outdated`)) } } } diff --git a/src/core/utils.ts b/src/core/utils.ts index d91db35..eec1d60 100644 --- a/src/core/utils.ts +++ b/src/core/utils.ts @@ -43,3 +43,9 @@ export function flatten(arrays: T[]): ArrayType[] { export function normalizePaths(paths: string[]): string[] { return paths.map((path) => normalize(path)) } + +export function normalizeCss(text: string): string { + const csso = require('csso') + // workaround https://github.com/css/csso/issues/422 + return csso.minify(text.replace(/--/g, '____')).css.replace(/____/g, '--') +} From e081cea356cfbdd0bf1f1ad802e4976c76d3ba31 Mon Sep 17 00:00:00 2001 From: Valentin Sarychev Date: Mon, 5 Oct 2020 12:22:34 +0300 Subject: [PATCH 3/3] fixup! fixup! feat: add --check option change option description --- src/cli/build.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/cli/build.ts b/src/cli/build.ts index 4f55a33..803eea8 100644 --- a/src/cli/build.ts +++ b/src/cli/build.ts @@ -44,7 +44,7 @@ export default class Build extends Command { description: 'Builds selected outputs.', }), check: flags.boolean({ - description: 'Checks output files will not be modified on build', + description: 'Checks existent output files satisfy the config file.', default: false, }), }