Merge pull request #9 from SimplrJS/feature/globby

Feature/globby

Author: DeividasBakanas

@types/arguments.d.ts

@@ -1,2 +1,2 @@
-import { Options } from "./contracts";
-export declare const Arguments: Options;
+import { CLIOptions } from "./contracts";
+export declare const Arguments: CLIOptions;

@types/cli-handler.d.ts

@@ -1,15 +1,13 @@
-import { Options } from "./contracts";
+import { CLIOptions } from "./contracts";
 export declare class CLIHandler {
     private options;
-    constructor(options: Options);
+    constructor(options: CLIOptions);
     private handleGlob();
-    private getFilesArray(pattern);
     private watchCss();
     private onWatchChange;
     private onWatchError;
     private emitWatchMessage();
     private convertFile(filePath);
     private resolveVarName(fileName);
     private constructFileName(fileName, extension?);
-    private snakeCaseToCamelCase(fileName);
 }

@types/contracts.d.ts

@@ -1,10 +1,11 @@
-export interface Options extends CssToTsOptions {
+export interface CLIOptions extends CssToTsOptions {
     removeSource?: boolean;
     pattern: string;
     watch?: boolean;
     cwd?: string;
     delimiter?: string;
     exclude?: string[];
+    outExt?: string;
 }
 export interface CssToTsOptions {
     rootDir: string;
@@ -13,6 +14,7 @@ export interface CssToTsOptions {
     prefix?: string;
     header?: string;
     varName?: string | boolean;
+    varType?: string;
 }
 export interface BasePackage {
     name: string;
@@ -22,3 +24,8 @@ export interface BasePackage {
     author?: string;
     license?: string;
 }
+export declare enum VarType {
+    Var = "var",
+    Let = "let",
+    Const = "const",
+}

@types/css-to-ts-converter.d.ts

@@ -1,11 +1,13 @@
+import { VarType } from "./contracts";
 export declare class CssToTsConverter {
-    private tsDir;
-    private tsFileName;
+    private outputDir;
+    private outputFileName;
     private cssDir;
     private cssFileName;
     private varName;
     private header;
     private removeSource;
-    constructor(tsDir: string, tsFileName: string, cssDir: string, cssFileName: string, varName: string, header?: string | undefined, removeSource?: boolean | undefined);
+    private varType;
+    constructor(outputDir: string, outputFileName: string, cssDir: string, cssFileName: string, varName: string, header?: string | undefined, removeSource?: boolean | undefined, varType?: VarType | undefined);
     Convert(): Promise<void>;
 }

@types/css-to-ts.d.ts

@@ -1 +1,2 @@
-export declare function ConvertCssToTs(stringifiedCss: string, variableName: string, headerComment?: string): string;
+import { VarType } from "./contracts";
+export declare function ConvertCssToTs(stringifiedCss: string, variableName: string, headerComment?: string, varType?: VarType): string;

@types/helpers.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
-import { Options } from "./contracts";
+import { CLIOptions } from "./contracts";
 export declare const CLI_ERROR_PREFIX = "CssToTs";
 export declare function EmitError(message: string): void;
-export declare const CLIDefaults: Options;
+export declare const CLIDefaults: CLIOptions;
 export declare function IsNodeError(error: any): error is NodeJS.ErrnoException;
+export declare function SnakeCaseToCamelCase(fileName: string): string;

@types/index.d.ts

@@ -2,4 +2,4 @@ export { Arguments } from "./arguments";
 export { CLIHandler } from "./cli-handler";
 export { CssToTsConverter } from "./css-to-ts-converter";
 export { ConvertCssToTs } from "./css-to-ts";
-export { Options, CssToTsOptions } from "./contracts";
+export { CLIOptions, CssToTsOptions } from "./contracts";

@types/validators.d.ts

@@ -0,0 +1,3 @@
+import { VarType } from "./contracts";
+export declare function IsVarNameValid(varName: string): boolean;
+export declare function IsVarTypeValid(varType: string): varType is VarType;

README.md

@@ -8,7 +8,7 @@ Compiles css files to importable TypeScript files.
 npm install css-to-ts -g
 ```
 
-Global installation is not necessary. You can install this package with 
+Global installation is not necessary. You can install this package with:
 
 ```sh
 npm install css-to-ts
@@ -38,6 +38,7 @@ css-to-ts -h
 | -v, --version                 | boolean   | `false`                   | Show current version.                                                         |
 | --rootDir                     | string    | `./`                      | Specifies the root directory of input files.                                  |
 | --outDir                      | string    | `./`                      | Redirect output structure to the directory.                                   |
+| --outExt                      | string    | `ts`                      | Specifies extension of output TypeScript file.                                |
 | --pattern                     | string    | `**/*.css`                | Files glob pattern.                                                           |
 | -w, --watch                   | boolean   | `false`                   | Watch for changes of input files.                                             |
 | --prefix                      | string    |                           | Prefix added to output file name.                                             |
@@ -48,6 +49,7 @@ css-to-ts -h
 | --cwd                         | string    | `process.cwd()`           | Specifies current working directory.                                          |
 | --exclude                     | array     | `["**/node_modules/**"]`  | Specifies an array of globs to exclude.                                       |
 | --varName                     | string    |                           | Specifies name of variable to be exported in TypeScript file.                 |
+| --varType                     | string    | `const`                   | Specifies type of variable to be exported in TypeScript file.                 |
 
 ## Example
 
@@ -68,7 +70,7 @@ Generated `./dist/orange.ts`:
 
 ```ts
 // File generated with css-to-ts
-export var Orange = `.orange {
+export const Orange = `.orange {
     color: orange;
     border: 1px solid yellow;
 }`;
@@ -77,7 +79,7 @@ export var Orange = `.orange {
 
 ## API
 
-### `ConvertCssToTs(stringifiedCss: string, variableName: string, headerComment?: string): string`
+### `ConvertCssToTs(stringifiedCss: string, variableName: string, headerComment?: string, varType: VarType = VarType.Const): string`
 
 Takes stringified css and outputs TypeScript code with exported string containing content of your css file.
 
@@ -92,8 +94,17 @@ import { ConvertCssToTs } from "css-to-ts";
 | `stringifiedCss`  | string | *        | Stringified css to be exported in TypeScript file.        |
 | `variableName`    | string | *        | Name of variable to be exported in TypeScript file.       |
 | `headerComment`   | string |          | Comment placed in the top of exported TypeScript file.    |
+| `varType`         | string |          | Type of variable to be exported in TypeScript file.       |
 
-### `new CssToTsConverter(tsDir, tsFileName, cssDir, cssFileName, varName, header, removeSource)`
+```ts
+export enum VarType {
+    Var = "var",
+    Let = "let",
+    Const = "const"
+}
+```
+
+### `new CssToTsConverter(outputDir, outputFileName, cssDir, cssFileName, varName, header, removeSource, varType)`
 
 Compiles css files to importable TypeScript files.
 
@@ -103,8 +114,8 @@ Usage:
 import { CssToTsConverter } from "css-to-ts";
 
 const converter = new CssToTsConverter(
-    tsDir,
-    tsFileName,
+    outputDir,
+    outputFileName,
     cssDir,
     cssFileName,
     varName,
@@ -121,13 +132,14 @@ try {
 
 | Constructor argument  | Type      | Required  | Description                                                   |
 |-----------------------|-----------|-----------|---------------------------------------------------------------|
-| `tsDir`               | string    | *         | Directory of TypeScript file.                                 |
-| `tsFileName`          | string    | *         | File name of TypeScript file.                                 |
+| `outputDir`           | string    | *         | Directory of output file.                                     |
+| `outputFileName`      | string    | *         | Name of output file.                                          |
 | `cssDir`              | string    | *         | Directory of css file.                                        |
 | `cssFileName`         | string    | *         | File name of css file.                                        |
 | `varName`             | string    | *         | Name of variable to be exported in TypeScript file.           |
 | `header`              | string    |           | Comment placed in the top of exported TypeScript file.        |
 | `removeSource`        | boolean   |           | Should css file be deleted after TypeScript file emitted.     |
+| `varType`             | VarType   |           | Type of variable to be exported in TypeScript file.           |
 
 ## License
 

dist/arguments.js

@@ -59,5 +59,13 @@ exports.Arguments = yargs
     .option("varName", {
     describe: "Specifies name of variable to be exported in TypeScript file.",
     type: "string"
+})
+    .option("varType", {
+    describe: "Specifies type of variable to be exported in TypeScript file. Valid values: `var`, `let`, `const`.",
+    type: "string"
+})
+    .option("outExt", {
+    describe: "Specifies extension of output TypeScript file.",
+    type: "string"
 })
     .argv;