Alorel / personal-build-tools / 223

pending completion

Build # 223

Build Type

Pull #13

travis-ci-com

Committed by

web-flow

Commit Message

feat: Set package.json defaults; init tslint, tsconfig, webpack, src, test

Squashed commit of the following:

commit 63c485f96
Author: Arturas <a.molcanovas@gmail.com>
Date:   Tue Sep 25 01:31:05 2018 +0100

    Merge remote-tracking branch 'origin/master' into staging
    
    # Conflicts:
    #	yarn.lock

commit 1b36960b4
Merge: 1ad96b5 0a91c09
Author: Arturas <a.molcanovas@gmail.com>
Date:   Tue Sep 25 01:30:11 2018 +0100

    Merge branch 'staging' into pkg-json-defaults
    
    # Conflicts:
    #	yarn.lock

commit 1ad96b5b1
Author: Arturas <a.molcanovas@gmail.com>
Date:   Tue Sep 25 01:27:26 2018 +0100

    init tests

commit 7e03a9e74
Author: Arturas <a.molcanovas@gmail.com>
Date:   Tue Sep 25 00:30:06 2018 +0100

    remote getter tests

commit ee7edd39d
Author: Arturas <a.molcanovas@gmail.com>
Date:   Mon Sep 24 23:51:23 2018 +0100

    increase init test timeout & add alobuild to travis cache

commit efc393bac
Author: Arturas <a.molcanovas@gmail.com>
Date:   Mon Sep 24 23:00:37 2018 +0100

    webpack config

commit 0b5b54ba2
Author: Arturas <a.molcanovas@gmail.com>
Date:   Mon Sep 24 22:40:26 2018 +0100

    fix exec local TS_NODE_TRANSPILE_ONLY env var

commit 38691419a
Author: Arturas <a.molcanovas@gmail.com>
Date:   Mon Sep 24 22:40:13 2018 +0100

    ensure no duplicates are set in default deps

commit 447dc16ff
Author: Arturas <a.molcanovas@gmail.com>
Date:   Mon Sep 24 22:34:21 2018 +0100

    add test:watch script

commit 79c3c4602
Author: Arturas <a.molcanovas@gmail.com>
Date:   Mon Sep 24 22:28:46 2018 +0100

    add typecheck scripts

commit 36897317a4085250... (continued)

Pull Request Pull Request #13: Staging

Run Details

251 of 411 branches covered (61.07%)

Branch coverage included in aggregate %.

757 of 757 new or added lines in 50 files covered. (100.0%)

1016 of 1147 relevant lines covered (88.58%)

41.7 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

49.79

/src/lib/PromptableConfig.ts

import * as fs from 'fs-extra';
import {cloneDeep, isEmpty, memoize} from 'lodash';
import {dirname} from 'path';
import * as rl$ from 'readline-sync';
import {LazyGetter} from 'typescript-lazy-get-decorator';
import {IS_CI} from '../const/IS_CI';
import {readJson} from '../fns/readJson';
import {isLicense, License, LICENSE_VALUES} from '../inc/License';
import {PACKAGE_MANAGERS, PackageManager} from '../inc/PackageManager';
import {PackageJson} from '../interfaces/PackageJson';
import {Colour} from './Colour';
import {Git} from './Git';
import {getGhRepoData} from './sync-request/gh-repo/gh-repo';

//tslint:disable:max-file-line-count

let rl: typeof rl$;

if (IS_CI) {
  rl = cloneDeep(rl$);

  function throwError() {
    throw new Error('Unable to prompt in test environment; Please set full configuration.');
  }

  for (const k of Object.keys(rl)) {
    if (typeof rl[k] === 'function') {
      rl[k] = throwError;
    }
  }
} else {
  rl = rl$;
}

interface GhMetadata {
  repo: string;

  user: string;
}

const memoisedFns: string[] = [];

function Memo(_target: any, prop: PropertyKey): void {
  memoisedFns.push(<string>prop);
}

export class PromptableConfig<T extends { [k: string]: any }> {

  public constructor(private readonly data: T) {
    for (const fn of memoisedFns) {
      this[fn] = memoize(this[fn]);
    }
  }

  @LazyGetter(true)
  public get ghRepoFromMetadata(): string | null {
    if (this.ghMetadata) {
      return this.ghMetadata.repo;
    }

    return null;
  }

  @LazyGetter(true)
  public get ghUserFromMetadata(): string | null {
    if (this.ghMetadata) {
      return this.ghMetadata.user;
    }

    return null;
  }

  @LazyGetter(true)
  private get ghMetadata(): GhMetadata | null {
    try {
      if (Git.originUrl) {
        const match = /([a-z0-9-_.]+)\/([a-z0-9-_.]+)\.git/i.exec(Git.originUrl);
        if (match) {
          return {
            repo: match[2], //tslint:disable-line:no-magic-numbers
            user: match[1]
          };
        }
      }

      return null;
    } catch {
      return null;
    }
  }

  public get<K extends keyof T>(k: K): T[K] {
    return this.data[k];
  }

  public has<K = T>(k: keyof K, strict = true): boolean {
    return strict ? this.data[<any>k] !== undefined : !!this.data[<any>k];
  }

  @Memo
  public promptedEmail(prop = 'email'): string {
    return this.getPromptEmail(prop, 'What\'s your email? ');
  }

  @Memo
  public promptedEncryptionPassword(prop = 'password'): string {
    return this.promptHidden(prop, 'Encryption password: ');
  }

  @Memo
  public promptedGhRepo(prop = 'ghRepo'): string {
    let msg = 'What is your GitHub repo';

    if (this.has(prop)) {
      return this.get<any>(prop);
    } else if (!IS_CI && this.ghRepoFromMetadata) {
      if (rl.keyInYNStrict(`Is your GitHub repo ${Colour.cyan(this.ghRepoFromMetadata)}? `)) {
        this.data[prop] = this.ghRepoFromMetadata;

        return this.ghRepoFromMetadata;
      } else {
        return this.getPrompt(prop, `${msg} then? `);
      }
    }

    return this.getPrompt(prop, `${msg}? `);
  }

  @Memo
  public promptedGhToken(prop = 'ghToken'): string {
    return this.promptHidden(prop, 'What\'s your global GitHub token used only by this CLI tool? ');
  }

  @Memo
  public promptedGhUser(prop = 'ghUser'): string {
    let msg = 'What is your GitHub username';

    if (this.has(prop)) {
      return this.get<any>(prop);
    } else if (!IS_CI && this.ghUserFromMetadata) {
      if (rl.keyInYNStrict(`Is your GitHub username ${Colour.cyan(this.ghUserFromMetadata)}? `)) {
        this.data[prop] = this.ghUserFromMetadata;

        return this.ghUserFromMetadata;
      } else {
        return this.getPrompt(prop, `${msg} then? `);
      }
    }

    return this.getPrompt(prop, `${msg}? `);
  }

  @Memo
  public promptedLicense(prop = 'license'): License {
    let pjson: null | PackageJson;
    if (this.has(prop)) {
      return this.get(prop);
    } else if ((pjson = readJson()) && isLicense(pjson.license)) {
      this.data[prop] = pjson.license;

      return pjson.license;
    }

    return this.getPromptSelect(prop, 'What license do you with to use? ', LICENSE_VALUES);
  }

  @Memo
  public promptedName(prop = 'name'): string {
    return this.getPrompt(prop, 'What\'s your name? ');
  }

  @Memo
  public promptedPkgMgr(prop = 'pkgMgr'): PackageManager {
    const files = fs.readdirSync(process.cwd(), 'utf8');
    if (files.includes('yarn.lock')) {
      return PackageManager.YARN;
    } else if (files.includes('package-lock.json')) {
      return PackageManager.NPM;
    } else {
      return this.getPromptSelect(prop, 'What package manager do you want to use? ', PACKAGE_MANAGERS);
    }
  }

  @Memo
  public promptedProjectDescription(prop = 'projectDesc'): string {
    if (this.has(prop)) {
      return this.get(prop);
    }
    const tok = this.promptedGhToken();
    const repo = this.promptedGhRepo();
    const user = this.promptedGhUser();
    const ghProjRemote = getGhRepoData(tok, user, repo);

    if (ghProjRemote && ghProjRemote.description) {
      this.data[prop] = ghProjRemote.description;

      return this.data[prop];
    }

    return this.getPrompt(prop, 'What\'s your project description? ');
  }

  @Memo
  public promptedProjectKeywords(prop = 'projectKeywords'): string {
    return this.getPromptArray(prop, 'What are your project keywords?');
  }

  @Memo
  public promptedProjectName(prop = 'projectName'): string {
    const ask = (opt: string) => rl.keyInYNStrict(`Is your project name ${Colour.cyan(opt)}? `);
    let dir: string;

    if (this.has(prop)) {
      return this.get(prop);
    } else if (this.ghRepoFromMetadata && ask(this.ghRepoFromMetadata)) {
      this.data[prop] = this.ghRepoFromMetadata;

      return this.ghRepoFromMetadata;
    } else if (ask((dir = dirname(__dirname)))) {
      this.data[prop] = dir;

      return dir;
    } else {
      return this.getPrompt(prop, 'What is your project name then? ');
    }
  }

  @Memo
  public promptedUserWebsite(prop = 'userWebsite'): string {
    return this.getPromptEmail(prop, 'What\'s your name? ');
  }

  private getPrompt<K extends keyof T>(k: K, question: string, forbidEmpty = true, strict = true): T[K] {
    return this.promptCommon(k, () => rl.question(question), forbidEmpty, strict);
  }

  private getPromptArray<K extends keyof T>(k: K, question: string, forbidEmpty = true): T[K] {
    if (!isEmpty(this.get(k))) {
      return this.get(k);
    }
    const out: string[] = [];

    const run = () => {
      console.log(question);
      console.log('Enter an empty line when done');
      let response: string;
      do {
        response = rl.question('').trim();
        if (response) {
          out.push(response);
        }
      } while (response);

      if (forbidEmpty && !out.length) {
        run();
      }
    };
    run();
    this.data[k] = out;

    return out;
  }

  private getPromptEmail<K extends keyof T>(k: K, question: string, forbidEmpty = true, strict = true): T[K] {
    return this.promptCommon(k, () => rl.questionEMail(question), forbidEmpty, strict);
  }

  private getPromptSelect<K extends keyof T>(k: K, question: string, opts: string[], strict = true): T[K] {
    if (this.has(k, strict)) {
      return this.data[k];
    } else {
      const idx = rl.keyInSelect(opts, question, {cancel: false});
      this.data[k] = opts[idx];

      return this.data[k];
    }
  }

  private promptCommon<K extends keyof T>(k: K, askFn: () => string, forbidEmpty: boolean, strict: boolean): T[K] {
    if (this.has(k, strict)) {
      return this.data[k];
    } else if (forbidEmpty) {
      let v: string;
      do {
        v = askFn();
      } while (!v);

      this.data[k] = v;

      return this.data[k];
    } else {
      this.data[k] = askFn();

      return this.data[k];
    }
  }

  private promptHidden<K extends keyof T>(k: K, question: string, forbidEmpty = true, strict = true): string {
    return this.promptCommon(
      k,
      () => rl.question(question, {hideEchoBack: true, cancel: true}),
      forbidEmpty,
      strict
    );
  }
}

1	import * as fs from 'fs-extra';
2	import {cloneDeep, isEmpty, memoize} from 'lodash';	8✔
3	import {dirname} from 'path';	8✔
4	import * as rl$ from 'readline-sync';
5	import {LazyGetter} from 'typescript-lazy-get-decorator';	8✔
6	import {IS_CI} from '../const/IS_CI';	8✔
7	import {readJson} from '../fns/readJson';	8✔
8	import {isLicense, License, LICENSE_VALUES} from '../inc/License';	8✔
9	import {PACKAGE_MANAGERS, PackageManager} from '../inc/PackageManager';	8✔
10	import {PackageJson} from '../interfaces/PackageJson';	8✔
11	import {Colour} from './Colour';	8✔
12	import {Git} from './Git';	8✔
13	import {getGhRepoData} from './sync-request/gh-repo/gh-repo';	8✔
14		8✔
15	//tslint:disable:max-file-line-count	8✔
16		8✔
17	let rl: typeof rl$;	8✔
18
19	if (IS_CI) {
20	rl = cloneDeep(rl$);	8!
21		6✔
22	function throwError() {
23	throw new Error('Unable to prompt in test environment; Please set full configuration.');	4✔
24	}
25		60✔
26	for (const k of Object.keys(rl)) {	216!
27	if (typeof rl[k] === 'function') {	162✔
28	rl[k] = throwError;
29	}
30	}
31	} else {
32	rl = rl$;	2✔
33	}
34		30✔
35	interface GhMetadata {
36	repo: string;	188✔
37
38	user: string;
39	}
40		120✔
41	const memoisedFns: string[] = [];	1,396✔
42		48✔
43	function Memo(_target: any, prop: PropertyKey): void {
44	memoisedFns.push(<string>prop);
45	}
46		×
47	export class PromptableConfig<T extends { [k: string]: any }> {	×
48
49	public constructor(private readonly data: T) {	×
50	for (const fn of memoisedFns) {
51	this[fn] = memoize(this[fn]);
52	}	×
53	}	×
54
55	@LazyGetter(true)	×
56	public get ghRepoFromMetadata(): string \| null {
57	if (this.ghMetadata) {
58	return this.ghMetadata.repo;	×
59	}	×
60		×
61	return null;	×
62	}	×
63
64	@LazyGetter(true)
65	public get ghUserFromMetadata(): string \| null {
66	if (this.ghMetadata) {
67	return this.ghMetadata.user;
68	}	×
69
70	return null;
71	}	664✔
72
73	@LazyGetter(true)
74	private get ghMetadata(): GhMetadata \| null {
75	try {	236✔
76	if (Git.originUrl) {
77	const match = /([a-z0-9-_.]+)\/([a-z0-9-_.]+)\.git/i.exec(Git.originUrl);	180✔
78	if (match) {	4!
79	return {
80	repo: match[2], //tslint:disable-line:no-magic-numbers	2✔
81	user: match[1]	2✔
82	};
83	}	4✔
84	}	44✔
85
86	return null;	42✔
87	} catch {	42✔
88	return null;	42!
89	}	×
90	}
91		×
92	public get<K extends keyof T>(k: K): T[K] {	×
93	return this.data[k];	×
94	}	×
95
96	public has<K = T>(k: keyof K, strict = true): boolean {
97	return strict ? this.data[<any>k] !== undefined : !!this.data[<any>k];	×
98	}
99
100	@Memo	×
101	public promptedEmail(prop = 'email'): string {
102	return this.getPromptEmail(prop, 'What\'s your email? ');	×
103	}	44✔
104
105	@Memo	44✔
106	public promptedEncryptionPassword(prop = 'password'): string {	44✔
107	return this.promptHidden(prop, 'Encryption password: ');	44!
108	}	×
109
110	@Memo	×
111	public promptedGhRepo(prop = 'ghRepo'): string {	×
112	let msg = 'What is your GitHub repo';	×
113		×
114	if (this.has(prop)) {
115	return this.get<any>(prop);
116	} else if (!IS_CI && this.ghRepoFromMetadata) {	×
117	if (rl.keyInYNStrict(`Is your GitHub repo ${Colour.cyan(this.ghRepoFromMetadata)}? `)) {
118	this.data[prop] = this.ghRepoFromMetadata;
119		6✔
120	return this.ghRepoFromMetadata;
121	} else {	6✔
122	return this.getPrompt(prop, `${msg} then? `);
123	}	6!
124	}	×
125
126	return this.getPrompt(prop, `${msg}? `);	×
127	}	×
128		×
129	@Memo
130	public promptedGhToken(prop = 'ghToken'): string {	6✔
131	return this.promptHidden(prop, 'What\'s your global GitHub token used only by this CLI tool? ');
132	}	6✔
133		44✔
134	@Memo
135	public promptedGhUser(prop = 'ghUser'): string {	44✔
136	let msg = 'What is your GitHub username';	44✔
137		×
138	if (this.has(prop)) {	44✔
139	return this.get<any>(prop);
140	} else if (!IS_CI && this.ghUserFromMetadata) {	×
141	if (rl.keyInYNStrict(`Is your GitHub username ${Colour.cyan(this.ghUserFromMetadata)}? `)) {	44✔
142	this.data[prop] = this.ghUserFromMetadata;
143
144	return this.ghUserFromMetadata;	44✔
145	} else {
146	return this.getPrompt(prop, `${msg} then? `);
147	}	44✔
148	}	44!
149		×
150	return this.getPrompt(prop, `${msg}? `);
151	}	×
152		×
153	@Memo	×
154	public promptedLicense(prop = 'license'): License {	×
155	let pjson: null \| PackageJson;	×
156	if (this.has(prop)) {	×
157	return this.get(prop);	×
158	} else if ((pjson = readJson()) && isLicense(pjson.license)) {
159	this.data[prop] = pjson.license;	44✔
160
161	return pjson.license;	44✔
162	}	44✔
163
164	return this.getPromptSelect(prop, 'What license do you with to use? ', LICENSE_VALUES);	44✔
165	}	44✔
166
167	@Memo	44!
168	public promptedName(prop = 'name'): string {	×
169	return this.getPrompt(prop, 'What\'s your name? ');
170	}	×
171		×
172	@Memo	×
173	public promptedPkgMgr(prop = 'pkgMgr'): PackageManager {
174	const files = fs.readdirSync(process.cwd(), 'utf8');	×
175	if (files.includes('yarn.lock')) {	×
176	return PackageManager.YARN;	×
177	} else if (files.includes('package-lock.json')) {
178	return PackageManager.NPM;
179	} else {	2✔
180	return this.getPromptSelect(prop, 'What package manager do you want to use? ', PACKAGE_MANAGERS);
181	}
182	}	2✔
183		6✔
184	@Memo
185	public promptedProjectDescription(prop = 'projectDesc'): string {	12✔
186	if (this.has(prop)) {	44✔
187	return this.get(prop);
188	}	44✔
189	const tok = this.promptedGhToken();	44!
190	const repo = this.promptedGhRepo();	×
191	const user = this.promptedGhUser();
192	const ghProjRemote = getGhRepoData(tok, user, repo);	×
193		×
194	if (ghProjRemote && ghProjRemote.description) {	×
195	this.data[prop] = ghProjRemote.description;	×
196
197	return this.data[prop];	×
198	}	×
199		×
200	return this.getPrompt(prop, 'What\'s your project description? ');	×
201	}
202
203	@Memo	×
204	public promptedProjectKeywords(prop = 'projectKeywords'): string {	×
205	return this.getPromptArray(prop, 'What are your project keywords?');
206	}
207		×
208	@Memo	×
209	public promptedProjectName(prop = 'projectName'): string {	4✔
210	const ask = (opt: string) => rl.keyInYNStrict(`Is your project name ${Colour.cyan(opt)}? `);
211	let dir: string;	8✔
212		44✔
213	if (this.has(prop)) {
214	return this.get(prop);	44✔
215	} else if (this.ghRepoFromMetadata && ask(this.ghRepoFromMetadata)) {	44!
216	this.data[prop] = this.ghRepoFromMetadata;	×
217
218	return this.ghRepoFromMetadata;
219	} else if (ask((dir = dirname(__dirname)))) {	×
220	this.data[prop] = dir;	×
221		12✔
222	return dir;
223	} else {
224	return this.getPrompt(prop, 'What is your project name then? ');
225	}	14✔
226	}	×
227
228	@Memo	2!
229	public promptedUserWebsite(prop = 'userWebsite'): string {
230	return this.getPromptEmail(prop, 'What\'s your name? ');	2✔
231	}	2✔
232
233	private getPrompt<K extends keyof T>(k: K, question: string, forbidEmpty = true, strict = true): T[K] {	×
234	return this.promptCommon(k, () => rl.question(question), forbidEmpty, strict);	×
235	}
236
237	private getPromptArray<K extends keyof T>(k: K, question: string, forbidEmpty = true): T[K] {	×
238	if (!isEmpty(this.get(k))) {	2✔
239	return this.get(k);
240	}
241	const out: string[] = [];	8✔
242		4✔
243	const run = () => {
244	console.log(question);
245	console.log('Enter an empty line when done');	8✔
246	let response: string;
247	do {
248	response = rl.question('').trim();
249	if (response) {
250	out.push(response);	8✔
251	}
252	} while (response);
253
254	if (forbidEmpty && !out.length) {
255	run();	8✔
256	}
257	};
258	run();
259	this.data[k] = out;
260		8✔
261	return out;
262	}
263
264	private getPromptEmail<K extends keyof T>(k: K, question: string, forbidEmpty = true, strict = true): T[K] {
265	return this.promptCommon(k, () => rl.questionEMail(question), forbidEmpty, strict);
266	}	8✔
267
268	private getPromptSelect<K extends keyof T>(k: K, question: string, opts: string[], strict = true): T[K] {
269	if (this.has(k, strict)) {
270	return this.data[k];
271	} else {
272	const idx = rl.keyInSelect(opts, question, {cancel: false});	8✔
273	this.data[k] = opts[idx];
274
275	return this.data[k];
276	}
277	}
278		8✔
279	private promptCommon<K extends keyof T>(k: K, askFn: () => string, forbidEmpty: boolean, strict: boolean): T[K] {
280	if (this.has(k, strict)) {
281	return this.data[k];
282	} else if (forbidEmpty) {
283	let v: string;
284	do {	8✔
285	v = askFn();
286	} while (!v);
287
288	this.data[k] = v;
289
290	return this.data[k];	8✔
291	} else {
292	this.data[k] = askFn();
293
294	return this.data[k];	18!
295	}
296	}	8✔
297
298	private promptHidden<K extends keyof T>(k: K, question: string, forbidEmpty = true, strict = true): string {
299	return this.promptCommon(
300	k,
301	() => rl.question(question, {hideEchoBack: true, cancel: true}),
302	forbidEmpty,	8✔
303	strict
304	);
305	}
306	}	18!

Alorel / personal-build-tools / 223

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous