Merge pull request #7 from kwonoj/feat-version

feat(cli): display version

Author: kwonoj

package.json

@@ -15,7 +15,7 @@
     "commitizen": {
       "path": "cz-conventional-changelog"
     },
-    "libsass-version": "3.5.4-180708-3"
+    "libsass-version": "3.5.4-180709.2"
   },
   "lint-staged": {
     "*.{ts,js}": [

src/SassAsmModule.ts

@@ -0,0 +1,60 @@
+/** @internal */
+type stringToUTF8Signature = (str: string, outPtr: number, maxBytesToWrite: number) => void;
+
+/** @internal */
+type cwrapSignature = <T = Function>(fn: string, returnType: string | null, parameterType: Array<string>) => T;
+
+/** @internal */
+type FILESYSTEMS = {
+  NODEFS: any;
+  /* MEMFS: any; */ //libsass-asm does not support memfs, disabled
+};
+
+/**
+ * Subset of internal filesystem api for wasm module.
+ */
+/** @internal */
+type FS = {
+  filesystems: FILESYSTEMS;
+  stat: (path: string) => import('fs').Stats;
+  isDir: (mode: number) => boolean;
+  isFile: (mode: number) => boolean;
+  mkdir: (path: string, mode?: number) => void;
+  mount: (type: FILESYSTEMS, option: { root?: string }, mountpoint: string) => void;
+  writeFile: (path: string, data: ArrayBufferView, opts: { encoding?: string; flags?: string }) => void;
+  unlink: (path: string) => void;
+  unmount: (mountpoint: string) => void;
+  rmdir: (path: string) => void;
+};
+
+/**
+ * @internal
+ *
+ * Interface for module generated by emscripten to load wasm binary.
+ * https://kripken.github.io/emscripten-site/docs/api_reference/preamble.js.html
+ */
+interface SassAsmModule {
+  cwrap: cwrapSignature;
+  FS: FS;
+  stringToUTF8: stringToUTF8Signature;
+  stackAlloc: (length: number) => number;
+  stackSave: () => number;
+  stackRestore: (stack: number) => void;
+  getValue: <T = any>(ptr: number, type: string, nosafe?: boolean) => T;
+  Pointer_stringify: (ptr: number) => string;
+  initializeRuntime(): Promise<boolean>;
+}
+
+/**
+ * @internal
+ *
+ * libsass functions exported via EXPORTED_FUNCTIONS,
+ * scope: Miscellaneous(https://github.com/sass/libsass/blob/master/docs/api-doc.md#miscellaneous-api-functions)
+ */
+interface SassAsmModule {
+  _libsass_version: () => number;
+  _libsass_language_version: () => number;
+  _sass2scss_version: () => number;
+}
+
+export { stringToUTF8Signature, cwrapSignature, FILESYSTEMS, FS, SassAsmModule };

src/SassFactory.ts

@@ -0,0 +1,14 @@
+/**
+ * Interface to factory object loaded via `loadModule`,
+ * provides interop interface to libsass functions.
+ */
+interface SassFactory {
+  getVersion: () => Promise<{
+    libsassAsm: string;
+    libsass: string;
+    sassLang: string;
+    sass2scss: string;
+  }>;
+}
+
+export { SassFactory };

src/ambient.d.ts

@@ -0,0 +1 @@
+declare module '*/lib/libsass';

src/cli.ts

@@ -1,13 +1,21 @@
 #!/usr/bin/env node
+import chalk from 'chalk';
 import * as commandLineArgs from 'command-line-args';
 
+/**
+ * Supported output style. Mirrors `style_option_strings[]` in sassc
+ * (https://github.com/sass/sassc/blob/6a64d0569205bfcf0794a473f97affcb60b22fcc/sassc.c#L184-L189)
+ */
 enum StyleOption {
   SASS_STYLE_COMPRESSED = 'compressed',
   SASS_STYLE_COMPACT = 'compact',
   SASS_STYLE_EXPANDED = 'expanded',
   SASS_STYLE_NESTED = 'nested'
 }
 
+/**
+ * Definitions of available command line args.
+ */
 const optionDefinitions = [
   { name: 'stdin', alias: 's', description: 'Read input from standard input instead of an input file.' },
   {
@@ -22,18 +30,43 @@ const optionDefinitions = [
   { name: 'omit-map-comment', alias: 'M', description: 'Omits the source map url comment.' },
   { name: 'precision', alias: 'p', description: 'Set the precision for numbers.' },
   { name: 'sass', alias: 'a', description: 'Treat input as indented syntax.' },
-  { name: 'version', alias: 'v', description: 'Display compiled versions.' },
+  { name: 'version', alias: 'v', description: 'Display compiled versions.', type: Boolean },
   { name: 'help', alias: 'h', description: 'Display this help message.', type: Boolean }
 ];
 
+/**
+ * Get usage definition for library version.
+ *
+ */
+const buildDisplayVersion = async () => {
+  const { loadModule } = await import('./loadModule');
+  const sassFactory = await loadModule();
+  const { libsassAsm, libsass, sassLang, sass2scss } = await sassFactory.getVersion();
+
+  return {
+    header: chalk.reset('Version'),
+    content: [
+      { name: 'libsass-asm', summary: libsassAsm },
+      { name: 'libsass', summary: libsass },
+      { name: 'sass', summary: sassLang },
+      { name: 'sass2scss', summary: sass2scss }
+    ]
+  };
+};
+
 (async () => {
   const options = commandLineArgs(optionDefinitions, { camelCase: true });
 
-  if (options.help || Object.keys(options).length === 0) {
-    const commandLineUsage = await import('command-line-usage');
-    const usage = commandLineUsage([{ header: 'Options', optionList: optionDefinitions }]);
+  const displayHelp = options.help || Object.keys(options).length === 0;
+  const displayVersion = options.version;
+
+  if (displayHelp || displayVersion) {
+    const cmdUsage = await import('command-line-usage');
+    const usageDefinition = displayHelp
+      ? { header: chalk.reset('Options'), optionList: optionDefinitions }
+      : await buildDisplayVersion();
+    const usage = cmdUsage([usageDefinition]);
     console.log(usage);
-  } else if (options.version) {
     return;
   }
 })();

src/interop/miscellaneous.ts

@@ -0,0 +1,24 @@
+import { SassAsmModule } from '../SassAsmModule';
+
+/**
+ * Creates function to read versions of library.
+ * @param asmModule
+ */
+const getVersion = (asmModule: SassAsmModule) => async () => {
+  const { stackSave, stackRestore, Pointer_stringify } = asmModule;
+  //version functions doesn't need param type conversion, call directly without cwrap
+  const { _libsass_version, _libsass_language_version, _sass2scss_version } = asmModule;
+
+  const { version } = await import('../../package.json');
+  const stack = stackSave();
+  const ret = {
+    libsassAsm: version,
+    libsass: Pointer_stringify(_libsass_version()),
+    sassLang: Pointer_stringify(_libsass_language_version()),
+    sass2scss: Pointer_stringify(_sass2scss_version())
+  };
+  stackRestore(stack);
+  return ret;
+};
+
+export { getVersion };

src/loadModule.ts

@@ -0,0 +1,22 @@
+import { getModuleLoader } from 'emscripten-wasm-loader';
+import { SassAsmModule } from './SassAsmModule';
+import { SassFactory } from './SassFactory';
+import { sassLoader } from './sassLoader';
+import { log } from './util/logger';
+
+/**
+ * Load, initialize wasm binary to use actual sass instance.
+ *
+ * @returns {Promise<SassFactory>} Function to load module
+ */
+const loadModule = async (): Promise<SassFactory> => {
+  log(`loadModule: loading libsass module`);
+
+  //imports MODULARIZED emscripten preamble
+  const runtimeModule = await import('./lib/libsass');
+  const moduleLoader = await getModuleLoader<SassFactory, SassAsmModule>(sassLoader, runtimeModule);
+
+  return moduleLoader();
+};
+
+export { loadModule };

src/sassLoader.ts

@@ -0,0 +1,15 @@
+import { getVersion } from './interop/miscellaneous';
+import { SassAsmModule } from './SassAsmModule';
+import { SassFactory } from './SassFactory';
+
+/**
+ * Create SassFactory interface object through loaded libass wasm module.
+ *
+ * @param {SassAsmModule} asmModule wasm module
+ * @returns {SassFactory}
+ */
+export const sassLoader = (asmModule: SassAsmModule): SassFactory => {
+  return {
+    getVersion: getVersion(asmModule)
+  };
+};

tsconfig.json

@@ -16,6 +16,7 @@
     "importHelpers": true,
     "pretty": true,
     "target": "es2017",
+    "resolveJsonModule": true,
     "outDir": "dist",
     "lib": [
       "es5",