From 2149dd57ea90be92bb282e4c01c8edfed90546c5 Mon Sep 17 00:00:00 2001 From: Eran Levin Date: Sat, 5 Oct 2019 17:45:50 +0300 Subject: [PATCH 1/4] avoid intellij files in the project. --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 15be2208..3bd11cc6 100644 --- a/.gitignore +++ b/.gitignore @@ -10,3 +10,4 @@ yarn-error.log # lockfiles yarn.lock package-lock.json +/.idea/ From 6a9f02f8ce740a8de6c76c2d6db54e273221fbfc Mon Sep 17 00:00:00 2001 From: Eran Levin Date: Sat, 5 Oct 2019 18:30:12 +0300 Subject: [PATCH 2/4] init tsc for the package. --- tsconfig.json | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 63 insertions(+) create mode 100644 tsconfig.json diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 00000000..65b2ea22 --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,63 @@ +{ + "compilerOptions": { + /* Basic Options */ + // "incremental": true, /* Enable incremental compilation */ + "target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' 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": "./", /* Redirect output structure to the directory. */ + // "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */ + // "composite": true, /* Enable project compilation */ + // "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */ + // "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'). */ + + /* 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": "src", /* 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": ["src/"], /* 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. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + + /* 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. */ + } +} From 032024e5210b5df40610121471f0d6db159eb568 Mon Sep 17 00:00:00 2001 From: Eran Levin Date: Sat, 5 Oct 2019 19:01:42 +0300 Subject: [PATCH 3/4] add definition files --- src/browser.d.ts | 49 ++++++++++++++++++++++++++++++++++++++++++++++++ src/common.d.ts | 45 ++++++++++++++++++++++++++++++++++++++++++++ src/index.d.ts | 9 +++++++++ src/node.d.ts | 45 ++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 148 insertions(+) create mode 100644 src/browser.d.ts create mode 100644 src/common.d.ts create mode 100644 src/index.d.ts create mode 100644 src/node.d.ts diff --git a/src/browser.d.ts b/src/browser.d.ts new file mode 100644 index 00000000..f84cc1a7 --- /dev/null +++ b/src/browser.d.ts @@ -0,0 +1,49 @@ +export=browser +declare namespace browser +{ + /** + * Currently only WebKit-based Web Inspectors, Firefox >= v31, + * and the Firebug extension (any Firefox version) are known + * to support "%c" CSS customizations. + * + * TODO: add a `localStorage` variable to explicitly enable/disable colors + */ + function useColors(): boolean; + + /** + * Colorize log arguments if enabled. + * + * @api public + */ + function formatArgs(args: string[]): void; + + /** + * Save `namespaces`. + * + * @param {String} namespaces + * @api private + */ + function save(namespaces: string): void; + + /** + * Load `namespaces`. + * + * @return {String} returns the previously persisted debug modes + * @api private + */ + function load(): string; + + /** + * Localstorage attempts to return the localstorage. + * + * This is necessary because safari throws + * when a user disables cookies/localstorage + * and you attempt to access it. + * + * @return {LocalStorage} + * @api private + */ + function localstorage(): Storage; + + const formatters: { j: (str:string) => string }; +} diff --git a/src/common.d.ts b/src/common.d.ts new file mode 100644 index 00000000..a76827e6 --- /dev/null +++ b/src/common.d.ts @@ -0,0 +1,45 @@ +type DebugNamespace = { + (...args: string[]): void; + namespace: string; + enabled: boolean; + useColors: boolean; + color: number | string; + destroy: () => boolean; + extend: (namespace: string, delimiter: string) => DebugNamespace; +}; + +type DebugType = { + (namespace: string): DebugNamespace; + debug: DebugType; + default: DebugNamespace; + coerce: (val: T) => T; + disable: () => string; + enable: (namespaces: string) => void; + enabled: (name: string) => boolean; + humanize: (timeInMs:number)=>string; + /** + * Active `debug` instances. + */ + instances: DebugNamespace[]; + /** + * The currently active debug mode names, and names to skip. + */ + names: string[]; + skips: string[]; + /** + * Map of special "%n" handling functions, for the debug "format" argument. + * + * Valid key names are a single, lower or upper-case letter, i.e. "n" and "N". + */ + formatters: {}; + selectColor: (namespace: string) => number; +}; + +/** + * This is the common logic for both the Node.js and web browser + * implementations of `debug()`. + */ + +import node = require("node"); +import browser = require("browser"); +declare function setup(env:typeof node|typeof browser ): DebugType; diff --git a/src/index.d.ts b/src/index.d.ts new file mode 100644 index 00000000..86e6b530 --- /dev/null +++ b/src/index.d.ts @@ -0,0 +1,9 @@ +/** + * Detect Electron renderer / nwjs process, which is node, but we should + * treat as a browser. + */ +import node = require("node"); +import browser = require("browser"); +type isBrowser=typeof window; +type index=isBrowser extends Object? typeof browser: typeof node; +export=index; diff --git a/src/node.d.ts b/src/node.d.ts new file mode 100644 index 00000000..1bce4fe3 --- /dev/null +++ b/src/node.d.ts @@ -0,0 +1,45 @@ +/** + * Module dependencies. + */ +import TTY=require("tty"); +import Util=require("util"); + +declare const tty: typeof TTY; +declare const util: typeof Util; +/** + * Is stdout a TTY? Colored output is enabled when `true`. + */ +declare function useColors(): boolean; +/** + * Adds ANSI color escape codes if enabled. + * + * @api public + */ +declare function formatArgs(args: any): void; +declare function getDate(): string; +/** + * Invokes `util.format()` with the specified arguments and writes to stderr. + */ +declare function log(...args: any[]): boolean; +/** + * Save `namespaces`. + * + * @param {String} namespaces + * @api private + */ +declare function save(namespaces: string): void; +/** + * Load `namespaces`. + * + * @return {String} returns the previously persisted debug modes + * @api private + */ +declare function load(): string; +/** + * Init logic for `debug` instances. + * + * Create a new `inspectOpts` object in case `useColors` is set + * differently for a particular `debug` instance. + */ +declare function init(debug: any): void; +declare const formatters: {o:()=>string,O:()=>string}; From ec7a30bdc21fcc5be014936d32fb70f0d77afa7a Mon Sep 17 00:00:00 2001 From: Eran Levin Date: Sat, 5 Oct 2019 19:26:01 +0300 Subject: [PATCH 4/4] and of course add types reference --- package.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index 643af019..7fba2a74 100644 --- a/package.json +++ b/package.json @@ -47,5 +47,6 @@ "xo": "^0.23.0" }, "main": "./src/index.js", - "browser": "./src/browser.js" + "browser": "./src/browser.js", + "types": "./src/index.d.ts" }