feat: add transform command and expose process config from api

joneff · Sep 9, 2022 · 1eff9eb · 1eff9eb
1 parent e32c87d
commit 1eff9eb
Show file tree

Hide file tree

Showing 42 changed files with 775 additions and 325 deletions.
diff --git a/README.md b/README.md
@@ -79,7 +79,7 @@ const output = {
     filename: '[name:toLower].css' // specify output file name; defaults to '[name].css'
 };
 const options = {
-    implementation: 'sass-embedded', // defaults to 'node-sass',
+    compiler: 'sass-embedded', // defaults to 'node-sass',
     api: 'modern', // defaults to 'legacy'
     sassOptions: {
         minify: true // defaults to false
@@ -109,9 +109,9 @@ module.exports = {
         // * caching
         'sass-build:recommended'
     ],
-    files: [
+    build: [
         {
-            // use packages/default as the folder in which all lookup is based. default is the process.cwd()
+            // use packages/default as the folder in which all lookup is based. default is process.cwd()
             cwd: 'packages/default',
             // path to source file, relative to cwd
             file: 'scss/all.scss',
@@ -123,7 +123,7 @@ module.exports = {
             file: 'scss/all.scss',
             outFile: 'dist/all.css',
             // use different sass implementation
-            implementation: 'sass-embedded',
+            compiler: 'sass-embedded',
             // use @use instead of @import syntax
             api: 'modern'
         }

diff --git a/__tests__/sass-build/sass-build.test.ts b/__tests__/sass-build/sass-build.test.ts
@@ -23,7 +23,7 @@ const FIXTURES_PATH = path.resolve( __dirname, '../__fixtures__' );
             fs.rmSync( `${FIXTURES_PATH}/dist`, { recursive: true, force: true } );
         });
 
-        const opts : Partial<CliOptions> = {
+        const opts : Partial<CliBuildOptions> = {
             api: 'legacy'
         };
 
@@ -33,7 +33,7 @@ const FIXTURES_PATH = path.resolve( __dirname, '../__fixtures__' );
         describe( 'sassBuild', () => {
 
             test('sassBuild compiles', () => {
-                sassBuild( file, outFile, <CliOptions> opts );
+                sassBuild( file, outFile, <CliBuildOptions> opts );
                 assert.equal( fileExists( outFile ), true );
             });
 

diff --git a/__tests__/sass-compile/sass-compile.test.ts b/__tests__/sass-compile/sass-compile.test.ts
@@ -15,7 +15,7 @@ const FIXTURES_PATH = path.resolve( __dirname, '../__fixtures__' );
             logger.level = 'error';
         });
 
-        const opts : Partial<CliOptions> = {
+        const opts : Partial<CliBuildOptions> = {
             api: 'legacy'
         };
 
@@ -25,7 +25,7 @@ const FIXTURES_PATH = path.resolve( __dirname, '../__fixtures__' );
         describe( 'sassCompile', () => {
 
             test('sassCompile compiles', () => {
-                const fileContent = sassCompile( file, <CliOptions> opts );
+                const fileContent = sassCompile( file, <CliBuildOptions> opts );
                 assert.notEqual( fileContent, '' );
             });
 
@@ -35,13 +35,13 @@ const FIXTURES_PATH = path.resolve( __dirname, '../__fixtures__' );
 
             test('minify: true', () => {
                 const sassOptions : Partial<SassOptions> = { minify: true };
-                const fileContent = sassCompile( file, <CliOptions> { ...opts, sassOptions } );
+                const fileContent = sassCompile( file, <CliBuildOptions> { ...opts, sassOptions } );
 
                 assert.equal( fileContent, 'body{color:red}\n' );
             });
             test('minify: false', () => {
                 const sassOptions : Partial<SassOptions> = { minify: false };
-                const fileContent = sassCompile( file, <CliOptions> { ...opts, sassOptions } );
+                const fileContent = sassCompile( file, <CliBuildOptions> { ...opts, sassOptions } );
 
                 assert.equal( fileContent, 'body {\n    color: red;\n}\n' );
             });
@@ -52,7 +52,7 @@ const FIXTURES_PATH = path.resolve( __dirname, '../__fixtures__' );
 
             test('correct path', () => {
                 const sassOptions : Partial<SassOptions> = { loadPaths: [ FIXTURES_PATH ] };
-                const fileContent = sassCompile( nestedFile, <CliOptions> { ...opts, sassOptions } );
+                const fileContent = sassCompile( nestedFile, <CliBuildOptions> { ...opts, sassOptions } );
 
                 assert.notEqual( fileContent, '' );
             });

diff --git a/__tests__/sass-compiler/wrap-compiler.test.ts b/__tests__/sass-compiler/wrap-compiler.test.ts
@@ -10,7 +10,7 @@ describe( 'sass-compiler', () => {
         const NODE_SASS = 'node-sass';
         const DART_SASS = 'dart-sass';
         const SASS_EMBEDDED = 'sass-embedded';
-        const EMPTY_OPTS = <CliOptions>{};
+        const EMPTY_OPTS = <CliBuildOptions>{};
 
         test('Default wrapper compiler is node-sass', () => {
             const compiler = wrapCompiler( EMPTY_OPTS );
@@ -20,59 +20,59 @@ describe( 'sass-compiler', () => {
         });
 
         test(`Setting compiler name to 'node-sass' works correctly`, () => {
-            const compiler = wrapCompiler( { implementation: 'node-sass' } as CliOptions );
+            const compiler = wrapCompiler( { compiler: 'node-sass' } as CliBuildOptions );
             const compilerName = compiler.info.split('\t')[0];
 
             assert.equal(compilerName, NODE_SASS);
         });
 
         test(`Setting compiler name to 'sass' works correctly`, () => {
-            const compiler = wrapCompiler( { implementation: 'sass' } as CliOptions );
+            const compiler = wrapCompiler( { compiler: 'sass' } as CliBuildOptions );
             const compilerName = compiler.info.split('\t')[0];
 
             assert.equal(compilerName, DART_SASS);
         });
 
         test(`Setting compiler name to 'sass-embedded' works correctly`, () => {
-            const compiler = wrapCompiler( { implementation: 'sass-embedded' } as CliOptions );
+            const compiler = wrapCompiler( { compiler: 'sass-embedded' } as CliBuildOptions );
             const compilerName = compiler.info.split('\t')[0];
 
             assert.equal(compilerName, SASS_EMBEDDED);
         });
 
         test(`Setting compiler name to require('node-sass') works correctly`, () => {
-            const compiler = wrapCompiler( { implementation: require('node-sass') } as CliOptions );
+            const compiler = wrapCompiler( { compiler: require('node-sass') } as CliBuildOptions );
             const compilerName = compiler.info.split('\t')[0];
 
             assert.equal(compilerName, NODE_SASS);
         });
 
         test(`Setting compiler name to require('sass') works correctly`, () => {
-            const compiler = wrapCompiler( { implementation: require('sass') } as CliOptions );
+            const compiler = wrapCompiler( { compiler: require('sass') } as CliBuildOptions );
             const compilerName = compiler.info.split('\t')[0];
 
             assert.equal(compilerName, DART_SASS);
         });
 
         test(`Setting compiler name to require('sass-embedded') works correctly`, () => {
-            const compiler = wrapCompiler( { implementation: require('sass-embedded') } as CliOptions );
+            const compiler = wrapCompiler( { compiler: require('sass-embedded') } as CliBuildOptions );
             const compilerName = compiler.info.split('\t')[0];
 
             assert.equal(compilerName, SASS_EMBEDDED);
         });
 
         test('Setting invalid compiler throws an error', () => {
             assert.throws( () => {
-                wrapCompiler( { implementation: '' } as CliOptions );
+                wrapCompiler( { compiler: '' } as CliBuildOptions );
             });
             assert.throws( () => {
-                wrapCompiler( { implementation: 'glob' } as CliOptions );
+                wrapCompiler( { compiler: 'glob' } as CliBuildOptions );
             });
             assert.throws( () => {
-                wrapCompiler( { implementation: 'no-such-compiler' } as CliOptions );
+                wrapCompiler( { compiler: 'no-such-compiler' } as CliBuildOptions );
             });
             assert.throws( () => {
-                wrapCompiler( { implementation: require('glob') } as CliOptions );
+                wrapCompiler( { compiler: require('glob') } as CliBuildOptions );
             });
         });
 

diff --git a/lib/sass-build-recommended.js b/lib/sass-build-recommended.js
@@ -4,23 +4,30 @@ const cwd = process.cwd();
 const { sassCacheImporter } = require('../dist/importers/cache-importer');
 const { sassPackageImporter } = require('../dist/importers/package-importer');
 
-/** @type {CliOptions} */
+/** @type {ConfigOptions} */
 const config = {
-    cwd: cwd,
-    implementation: 'node-sass',
-    api: 'legacy',
-    sassOptions: {
-        minify: false,
-        functions: [],
-        importers: [
-            sassCacheImporter(),
-            sassPackageImporter({ cwd: cwd })
-        ]
-    },
-    postcss: [
-        calc({ precision: 10 }),
-        autoprefixer()
-    ]
+    defaults: {
+        transform: {
+            cwd: cwd
+        },
+        build: {
+            cwd: cwd,
+            compiler: 'node-sass',
+            api: 'legacy',
+            sassOptions: {
+                minify: false,
+                functions: [],
+                importers: [
+                    sassCacheImporter(),
+                    sassPackageImporter({ cwd: cwd })
+                ]
+            },
+            postcss: [
+                calc({ precision: 10 }),
+                autoprefixer()
+            ]
+        }
+    }
 };
 
 module.exports = config;
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -35,6 +35,7 @@
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
+    "@joneff/baka": "^2.0.0",
     "glob": "^8.0.3",
     "lodash": "^4.17.21",
     "mime-types": "^2.1.35",

diff --git a/src/build/build-files.ts b/src/build/build-files.ts
@@ -1,7 +1,7 @@
-import { wrapImplementation } from '../compiler';
+import { wrapCompiler } from '../compiler';
 
-export function sassBuildFiles( file: string | string[], output: OutputOptions = <OutputOptions>{}, options?: CliOptions ) : void {
-    const compiler = wrapImplementation( options );
+export function sassBuildFiles( file: string | string[], output: OutputOptions = <OutputOptions>{}, options?: CliBuildOptions ) : void {
+    const compiler = wrapCompiler( options );
 
     compiler.buildFiles( file, output, options?.sassOptions );
 }
diff --git a/src/build/build-string.ts b/src/build/build-string.ts
@@ -1,7 +1,7 @@
-import { wrapImplementation } from '../compiler';
+import { wrapCompiler } from '../compiler';
 
-export function sassBuildString( source: string, outFile: string, options?: CliOptions ) : void {
-    const compiler = wrapImplementation( options );
+export function sassBuildString( source: string, outFile: string, options?: CliBuildOptions ) : void {
+    const compiler = wrapCompiler( options );
 
     compiler.buildString( source, outFile, options?.sassOptions );
 }
diff --git a/src/build/build.ts b/src/build/build.ts
@@ -1,7 +1,7 @@
-import { wrapImplementation } from '../compiler';
+import { wrapCompiler } from '../compiler';
 
-export function sassBuild( file: string, outFile: string, options?: CliOptions ) : void {
-    const compiler = wrapImplementation( options );
+export function sassBuild( file: string, outFile: string, options?: CliBuildOptions ) : void {
+    const compiler = wrapCompiler( options );
 
     compiler.build( file, outFile, options?.sassOptions );
 }
diff --git a/src/cli/index.ts b/src/cli/index.ts
@@ -1,7 +1,7 @@
 import argsParser from 'yargs-parser';
 
 import * as commands from './commands';
-import { processConfig } from './process-config';
+import { processConfigFile } from '../config';
 import {
     exit,
     logger
@@ -61,7 +61,7 @@ export function cli() {
         logger.silly('cli', 'No config passed.');
     }
 
-    processConfig( config );
+    processConfigFile( config );
     exitSuccess();
 }