feat: added support for --only flag

Merge pull request #1731 from coralproject/next-watcher-flags

Watcher --only
Use JSDocs comments (#1727)


Merge branch 'next' into prevent-compile-loop-relay
Merge pull request #1726 from coralproject/prevent-compile-loop-relay

[next] Adapt relay watch config
[next] Remove nodemon (#1725)

* Remove old nodemon configs

* Remove nodemon

[next] Jest implementation for React Components (#1733)

* Make jest testing work with custom path and css modules

* Add first test

* feat: added unit tests to ci

* fix: updated package-lock.json

* Update cssTransform.js

* Update cssTransform.js

* Fix test in ci

Adapt files.exclude (#1736)


Permalink ui

Adding Copy to clipboard functionality

WIP

clean request

wip

progress

progress

work in progress

wip

ui functionality

Translations :/

wip

Merge branch 'permalink' of github.com:coralproject/talk into permalink

* 'permalink' of github.com:coralproject/talk: (42 commits)
  [next] Support server side jest testing (#1747)
  Update snapshots
  Add comments
  Remove precss
  Move react-responsive to dev deps
  Remove comment
  Mobile first approach
  Support standard css variables, dynamically set spacing-unit
  Add docs
  Fully implement Flex and MatchMedia
  Responsive Components <3
  fix: linting
  fix: adjusted pageInfo
  Remove obsoloe snapshot
  Move jsdom to dev deps
  Mark comments as always returning a value
  Add comment
  Fix unit tests
  Translate, concept for translation and id strings
  Add aria props
  ...

Adding Attachment and Popover Component

merge conflicts

progress

Any

Working

Support for refs

Ready

scripts/watcher/watch.ts

@@ -1,58 +1,106 @@
+import chalk from "chalk";
 import Joi from "joi";
-import path from "path";
+import { pickBy } from "lodash";
 
-import ChokidarWatcher from "./ChokidarWatcher";
-import { Config, configSchema, WatchConfig, Watcher } from "./types";
+import SaneWatcher from "./SaneWatcher";
+import { Config, configSchema, Options, WatchConfig, Watcher } from "./types";
 
 // Polyfill the asyncIterator symbol.
 if (Symbol.asyncIterator === undefined) {
   (Symbol as any).asyncIterator = Symbol.for("asyncIterator");
 }
 
-async function beginWatch(watcher: Watcher, key: string, config: WatchConfig) {
+async function beginWatch(
+  watcher: Watcher,
+  key: string,
+  config: WatchConfig,
+  rootDir: string
+) {
   const { paths, ignore, executor } = config;
   if (executor.onInit) {
-    executor.onInit();
+    await executor.onInit();
   }
-  for await (const filePath of watcher.watch(paths, { ignore })) {
+  for await (const filePath of watcher.watch(rootDir, paths, { ignore })) {
     // tslint:disable-next-line:no-console
-    console.log(`Execute "${key}"`);
+    console.log(chalk.cyanBright(`Execute "${key}"`));
     executor.execute(filePath);
   }
 }
 
-function prependRootDir(prepend: string, cfg: WatchConfig): WatchConfig {
-  const prependFunc = (p: string) => path.resolve(prepend, p);
-  return {
-    ...cfg,
-    paths: cfg.paths.map(prependFunc),
-    ignore: cfg.ignore ? cfg.ignore.map(prependFunc) : undefined,
-  };
-}
-
-function setupCleanup(config: Config) {
+function setupCleanup(watcher: Watcher, config: Config) {
   ["SIGINT", "SIGTERM"].forEach(signal =>
-    process.once(signal as any, () => {
+    process.once(signal as any, async () => {
+      const cleanups = [];
+      if (watcher.onCleanup) {
+        cleanups.push(watcher.onCleanup());
+      }
       for (const key of Object.keys(config.watchers)) {
         if (config.watchers[key].executor.onCleanup) {
-          config.watchers[key].executor.onCleanup!();
+          cleanups.push(config.watchers[key].executor.onCleanup!());
         }
       }
+      await Promise.all(cleanups);
       process.exit(0);
     })
   );
 }
 
-export default async function watch(config: Config) {
+function resolveSets(
+  sets: Record<string, ReadonlyArray<string>>,
+  value: ReadonlyArray<string>
+) {
+  const resolved: string[] = [];
+  value.forEach(v => {
+    if (v in sets) {
+      resolved.push(...sets[v]);
+      return;
+    }
+    resolved.push(v);
+  });
+  return resolved;
+}
+
+function filterOnly(
+  watchers: Config["watchers"],
+  only: ReadonlyArray<string>,
+  sets?: Record<string, ReadonlyArray<string>>
+): Config["watchers"] {
+  const resolved = sets ? resolveSets(sets, only) : only;
+  const unknown = resolved.filter(r => !(r in watchers));
+  if (unknown.length) {
+    throw new Error(`Watcher Configuration or Set for ${unknown} not found`);
+  }
+  return pickBy(watchers, (value, key) => {
+    if (resolved.indexOf(key) === -1) {
+      // tslint:disable-next-line:no-console
+      console.log(chalk.grey(`Disabled watcher "${key}"`));
+      return false;
+    }
+    return true;
+  }) as Config["watchers"];
+}
+
+export default async function watch(config: Config, options: Options = {}) {
   Joi.assert(config, configSchema);
-  const watcher = config.backend || new ChokidarWatcher();
-  setupCleanup(config);
-  for (const key of Object.keys(config.watchers)) {
+  const watcher: Watcher = config.backend || new SaneWatcher();
+  const rootDir = config.rootDir || process.cwd();
+  const defaultSet = config.defaultSet && [config.defaultSet];
+  const only = options.only && options.only.length ? options.only : defaultSet;
+
+  let watchersConfigs = config.watchers;
+  if (only) {
+    watchersConfigs = filterOnly(watchersConfigs, only, config.sets);
+  }
+
+  setupCleanup(watcher, config);
+  if (watcher.onInit) {
+    await watcher.onInit();
+  }
+
+  for (const key of Object.keys(watchersConfigs)) {
     // tslint:disable-next-line:no-console
-    console.log(`Start watcher "${key}"`);
-    const watcherConfig = config.rootDir
-      ? prependRootDir(config.rootDir, config.watchers[key])
-      : config.watchers[key];
-    beginWatch(watcher, key, watcherConfig);
+    console.log(chalk.cyanBright(`Start watcher "${key}"`));
+    const watcherConfig = watchersConfigs[key];
+    beginWatch(watcher, key, watcherConfig, rootDir);
   }
 }