Skip to content

Commit f543d08

Browse files
committed
initialize commit
0 parents  commit f543d08

11 files changed

+3743
-0
lines changed

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
node_modules
2+
lib

.prettierignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.json

.prettierrc

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"singleQuote": true
3+
}

package-lock.json

+3,569
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{
2+
"name": "@hackforplay/log",
3+
"version": "1.0.0",
4+
"description": "Logger for hackforplay written in TS.",
5+
"main": "lib/index.js",
6+
"scripts": {
7+
"build": "tsc",
8+
"test": "ava",
9+
"watch": "ava --watch"
10+
},
11+
"author": "HackforPlay, Inc.",
12+
"license": "MIT",
13+
"ava": {
14+
"compileEnhancements": false,
15+
"extensions": [
16+
"ts"
17+
],
18+
"files": [
19+
"./src/*.test.ts"
20+
],
21+
"require": [
22+
"ts-node/register/transpile-only"
23+
]
24+
},
25+
"dependencies": {
26+
"global": "^4.4.0"
27+
},
28+
"devDependencies": {
29+
"ava": "^2.3.0",
30+
"ts-node": "^8.3.0",
31+
"typescript": "^3.6.2"
32+
}
33+
}

src/index.test.ts

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
import test from 'ava';
2+
import { createLogger } from '.';
3+
4+
test('Create with same keys', t => {
5+
const logger1 = createLogger();
6+
const logger2 = createLogger();
7+
8+
t.is(logger1, logger2);
9+
});
10+
11+
test('Create with different keys', t => {
12+
const logger1 = createLogger('1');
13+
const logger2 = createLogger('2');
14+
15+
t.not(logger1, logger2);
16+
});

src/index.ts

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
import g from 'global';
2+
import { Logger } from './logger';
3+
4+
export function createLogger<T = IDefaultStructure>(
5+
primaryKey = 'Unique primary key used by @hackforplay/log'
6+
) {
7+
if (primaryKey in g) {
8+
return g[primaryKey] as Logger<T>;
9+
}
10+
11+
const logger = new Logger<T>();
12+
g[primaryKey] = logger;
13+
return logger;
14+
}
15+
16+
export interface IDefaultStructure {
17+
payload: string;
18+
}

src/logger.test.ts

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
import test from 'ava';
2+
import { Logger } from './logger';
3+
4+
test('Instantiate', t => {
5+
t.notThrows(() => {
6+
new Logger();
7+
});
8+
});

src/logger.ts

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
export type S<Structure> = (log: Structure) => void;
2+
3+
export class Logger<Structure> {
4+
private logs: Structure[] = [];
5+
private subscribers: Set<S<Structure>> = new Set();
6+
7+
append(log: Structure) {
8+
this.logs.push(log);
9+
this.subscribers.forEach(subscriber => {
10+
subscriber(log);
11+
});
12+
}
13+
14+
subscribe(subscriber: (log: Structure) => void): () => void {
15+
for (const log of this.logs) {
16+
subscriber(log);
17+
}
18+
19+
this.subscribers.add(subscriber);
20+
return () => {
21+
this.subscribers.delete(subscriber);
22+
};
23+
}
24+
}

tsconfig.json

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
{
2+
"compilerOptions": {
3+
/* Basic Options */
4+
// "incremental": true, /* Enable incremental compilation */
5+
"target": "es2015", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
6+
"module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
7+
// "lib": [], /* Specify library files to be included in the compilation. */
8+
// "allowJs": true, /* Allow javascript files to be compiled. */
9+
// "checkJs": true, /* Report errors in .js files. */
10+
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
11+
// "declaration": true, /* Generates corresponding '.d.ts' file. */
12+
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
13+
// "sourceMap": true, /* Generates corresponding '.map' file. */
14+
// "outFile": "./", /* Concatenate and emit output to single file. */
15+
"outDir": "./lib", /* Redirect output structure to the directory. */
16+
// "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
17+
// "composite": true, /* Enable project compilation */
18+
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
19+
// "removeComments": true, /* Do not emit comments to output. */
20+
// "noEmit": true, /* Do not emit outputs. */
21+
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
22+
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
23+
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
24+
25+
/* Strict Type-Checking Options */
26+
"strict": true, /* Enable all strict type-checking options. */
27+
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
28+
// "strictNullChecks": true, /* Enable strict null checks. */
29+
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
30+
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
31+
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
32+
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
33+
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
34+
35+
/* Additional Checks */
36+
// "noUnusedLocals": true, /* Report errors on unused locals. */
37+
// "noUnusedParameters": true, /* Report errors on unused parameters. */
38+
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
39+
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
40+
41+
/* Module Resolution Options */
42+
// "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
43+
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
44+
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
45+
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
46+
"typeRoots": ["types"], /* List of folders to include type definitions from. */
47+
// "types": [], /* Type declaration files to be included in compilation. */
48+
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
49+
"esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
50+
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
51+
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
52+
53+
/* Source Map Options */
54+
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
55+
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
56+
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
57+
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
58+
59+
/* Experimental Options */
60+
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
61+
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
62+
},
63+
"include": ["src", "types"],
64+
"exclude": ["src/*.test.ts"]
65+
}

types/global.d.ts

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
declare module 'global' {
2+
var global: any;
3+
export default global;
4+
}

0 commit comments

Comments
 (0)