@teambit/config-store 0.0.16 → 0.0.17

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/config-store",
-  "version": "0.0.16",
+  "version": "0.0.17",
   "homepage": "https://bit.cloud/teambit/harmony/config-store",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.harmony",
     "name": "config-store",
-    "version": "0.0.16"
+    "version": "0.0.17"
   },
   "dependencies": {
     "chalk": "4.1.2",
@@ -14,33 +14,45 @@
     "@teambit/gitconfig": "2.0.10",
     "lodash": "4.17.21",
     "fs-extra": "10.0.0",
-    "core-js": "^3.0.0",
-    "@babel/runtime": "7.20.0",
     "@teambit/harmony": "0.4.7",
-    "@teambit/cli": "0.0.1136",
+    "@teambit/cli": "0.0.1137",
     "@teambit/legacy.constants": "0.0.11"
   },
   "devDependencies": {
     "@types/lodash": "4.14.165",
     "@types/fs-extra": "9.0.7",
-    "@types/node": "12.20.4",
-    "@types/react": "^17.0.8",
-    "@types/react-dom": "^17.0.5",
-    "@types/jest": "^26.0.0",
-    "@types/testing-library__jest-dom": "5.9.5"
+    "@teambit/harmony.envs.core-aspect-env": "0.0.69"
   },
-  "peerDependencies": {
-    "react": "^16.8.0 || ^17.0.0",
-    "react-dom": "^16.8.0 || ^17.0.0"
-  },
-  "license": "SEE LICENSE IN UNLICENSED",
+  "peerDependencies": {},
+  "license": "Apache-2.0",
   "optionalDependencies": {},
   "peerDependenciesMeta": {},
   "exports": {
-    "node": {
-      "require": "./dist/index.js",
-      "import": "./dist/esm.mjs"
+    ".": {
+      "node": {
+        "require": "./dist/index.js",
+        "import": "./dist/esm.mjs"
+      },
+      "default": "./dist/index.js"
     },
-    "default": "./dist/index.js"
-  }
+    "./dist/*": "./dist/*",
+    "./artifacts/*": "./artifacts/*",
+    "./*": "./*.ts"
+  },
+  "private": false,
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/teambit/bit"
+  },
+  "keywords": [
+    "bit",
+    "bit-aspect",
+    "bit-core-aspect",
+    "components",
+    "collaboration",
+    "web"
+  ]
 }

package/types/asset.d.ts

@@ -5,12 +5,12 @@ declare module '*.png' {
 declare module '*.svg' {
   import type { FunctionComponent, SVGProps } from 'react';
 
-  export const ReactComponent: FunctionComponent<SVGProps<SVGSVGElement> & { title?: string }>;
+  export const ReactComponent: FunctionComponent<
+    SVGProps<SVGSVGElement> & { title?: string }
+  >;
   const src: string;
   export default src;
 }
-
-// @TODO Gilad
 declare module '*.jpg' {
   const value: any;
   export = value;
@@ -27,3 +27,15 @@ declare module '*.bmp' {
   const value: any;
   export = value;
 }
+declare module '*.otf' {
+  const value: any;
+  export = value;
+}
+declare module '*.woff' {
+  const value: any;
+  export = value;
+}
+declare module '*.woff2' {
+  const value: any;
+  export = value;
+}

package/config-cmd.ts

@@ -1,143 +0,0 @@
-/* eslint max-classes-per-file: 0 */
-import chalk from 'chalk';
-import rightpad from 'pad-right';
-import { BASE_DOCS_DOMAIN } from '@teambit/legacy.constants';
-import { Command, CommandOptions } from '@teambit/cli';
-import { ConfigStoreMain, StoreOrigin } from './config-store.main.runtime';
-
-class ConfigSet implements Command {
-  name = 'set <key> <val>';
-  description = 'set a configuration. default to save it globally';
-  extendedDescription = `to set temporary configuration by env variable, prefix with "BIT_CONFIG", replace "." with "_" and change to upper case.
-for example, "user.token" becomes "BIT_CONFIG_USER_TOKEN"`;
-  baseUrl = 'reference/config/bit-config/';
-  alias = '';
-  skipWorkspace = true;
-  options = [
-    ['l', 'local', 'set the configuration in the current scope (saved in .bit/scope.json)'],
-    ['t', 'local-track', 'set the configuration in the current workspace (saved in workspace.jsonc)'],
-  ] as CommandOptions;
-
-  constructor(private configStore: ConfigStoreMain) {}
-
-  async report([key, value]: [string, string], { local, localTrack }: { local?: boolean, localTrack?: boolean }) {
-    const getOrigin = () => {
-      if (local) return 'scope';
-      if (localTrack) return 'workspace';
-      return 'global';
-    }
-    await this.configStore.setConfig(key, value, getOrigin());
-    return chalk.green('added configuration successfully');
-  }
-}
-
-class ConfigGet implements Command {
-  name = 'get <key>';
-  description = 'get a value from global configuration';
-  alias = '';
-  options = [] as CommandOptions;
-
-  constructor(private configStore: ConfigStoreMain) {}
-
-  async report([key]: [string]) {
-    const value = this.configStore.getConfig(key);
-    return value || '';
-  }
-}
-
-class ConfigList implements Command {
-  name = 'list';
-  description = 'list all configuration(s)';
-  alias = '';
-  options = [
-    ['o', 'origin <origin>', 'list configuration specifically from the following: [scope, workspace, global]'],
-    ['d', 'detailed', 'list all configuration(s) with the origin'],
-    ['j', 'json', 'output as JSON'],
-  ] as CommandOptions;
-
-  constructor(private configStore: ConfigStoreMain) {}
-
-  async report(_, { origin, detailed }: { origin?: StoreOrigin, detailed?: boolean }) {
-
-    const objToFormattedString = (conf: Record<string, string>) => {
-      return Object.entries(conf)
-      .map((tuple) => {
-        tuple[0] = rightpad(tuple[0], 45, ' ');
-        return tuple.join('');
-      })
-      .join('\n');
-    }
-
-    if (origin) {
-      const conf = this.configStore.stores[origin].list();
-      return objToFormattedString(conf);
-    }
-
-    if (detailed) {
-      const formatTitle = (str: string) => chalk.bold(str.toUpperCase());
-      const origins = Object.keys(this.configStore.stores).map((originName) => {
-        const conf = this.configStore.stores[originName].list();
-        return formatTitle(originName) + '\n' + objToFormattedString(conf);
-      }).join('\n\n');
-      const combined = this.configStore.listConfig();
-
-      const combinedFormatted = objToFormattedString(combined);
-      return `${origins}\n\n${formatTitle('All Combined')}\n${combinedFormatted}`;
-    }
-
-    const conf = this.configStore.listConfig();
-    return objToFormattedString(conf);
-  }
-
-  async json(_, { origin, detailed }: { origin?: StoreOrigin, detailed?: boolean }) {
-    if (origin) {
-      return this.configStore.stores[origin].list();
-    }
-    if (detailed) {
-      const allStores = Object.keys(this.configStore.stores).reduce((acc, current) => {
-        acc[current] = this.configStore.stores[current].list();
-        return acc;
-      }, {} as Record<string, Record<string, string>>);
-      allStores.combined = this.configStore.listConfig();
-      return allStores;
-    }
-    return this.configStore.listConfig();
-  }
-}
-
-class ConfigDel implements Command {
-  name = 'del <key>';
-  description = 'delete given key from global configuration';
-  alias = '';
-  options = [
-    ['o', 'origin <origin>', 'default to delete whenever it found first. specify to delete specifically from the following: [scope, workspace, global]'],
-  ] as CommandOptions;
-
-  constructor(private configStore: ConfigStoreMain) {}
-
-  async report([key]: [string], { origin }: { origin?: StoreOrigin }) {
-    await this.configStore.delConfig(key, origin);
-    return chalk.green('deleted successfully');
-  }
-}
-
-export class ConfigCmd implements Command {
-  name = 'config';
-  description = 'config management';
-  extendedDescription = `${BASE_DOCS_DOMAIN}reference/config/bit-config`;
-  group = 'general';
-  alias = '';
-  loadAspects = false;
-  commands: Command[] = [];
-  options = [] as CommandOptions;
-
-  constructor(private configStore: ConfigStoreMain) {
-    this.commands = [
-      new ConfigSet(configStore), new ConfigDel(configStore), new ConfigGet(configStore), new ConfigList(configStore)
-    ];
-  }
-
-  async report() {
-    return new ConfigList(this.configStore).report(undefined, { });
-  }
-}

package/config-getter.ts

@@ -1,149 +0,0 @@
-import gitconfig from '@teambit/gitconfig';
-import { isNil } from 'lodash';
-import { getGlobalConfigPath, GlobalConfig } from './global-config';
-
-export const ENV_VARIABLE_CONFIG_PREFIX = 'BIT_CONFIG_';
-
-export interface Store {
-  list(): Record<string, string>;
-  set(key: string, value: string): void;
-  del(key: string): void;
-  write(): Promise<void>;
-  getPath(): string;
-  invalidateCache(): Promise<void>;
-}
-
-/**
- * Singleton cache for the config object. so it can be used everywhere even by non-aspects components.
- */
-export class ConfigGetter {
-  private _store: Record<string, string> | undefined;
-  private _globalConfig: GlobalConfig | undefined;
-  private gitStore: Record<string, string | undefined> = {};
-
-  get globalConfig() {
-    if (!this._globalConfig) {
-      this._globalConfig = GlobalConfig.loadSync();
-    }
-    return this._globalConfig;
-  }
-
-  get store() {
-    if (!this._store) {
-      this._store = this.globalConfig.toPlainObject();
-    }
-    return this._store;
-  }
-
-  /**
-   * in case a config-key exists in both, the new one (the given store) wins.
-   */
-  addStore(store: Store) {
-    const currentStore = this.store;
-    this._store = { ...currentStore, ...store.list() };
-  }
-
-  getConfig(key: string): string | undefined  {
-    if (!key) {
-      return undefined;
-    }
-
-    const envVarName = toEnvVariableName(key);
-    if (process.env[envVarName]) {
-      return process.env[envVarName];
-    }
-
-    const store = this.store;
-    const val = store[key];
-    if (!isNil(val)) {
-      return val;
-    }
-    const gitKeys = ['user.name', 'user.email'];
-    if (gitKeys.includes(key)) {
-      return this.getFromGit(key);
-    }
-  }
-  private getFromGit(key: string): string | undefined {
-    if (key in this.gitStore) {
-      return this.gitStore[key];
-    }
-    try {
-      const gitVal = gitconfig.get.sync(key);
-      this.gitStore[key] = gitVal;
-    } catch {
-      // Ignore error from git config get
-      this.gitStore[key] = undefined;
-    }
-    return this.gitStore[key];
-  }
-  getConfigNumeric(key: string): number | undefined {
-    const fromConfig = this.getConfig(key);
-    if (isNil(fromConfig)) return undefined;
-    const num = Number(fromConfig);
-    if (Number.isNaN(num)) {
-      throw new Error(`config of "${key}" is invalid. Expected number, got "${fromConfig}"`);
-    }
-    return num;
-  }
-  getConfigBoolean(key: string): boolean | undefined {
-    const result = this.getConfig(key);
-    if (isNil(result)) return undefined;
-    if (typeof result === 'boolean') return result;
-    if (result === 'true') return true;
-    if (result === 'false') return false;
-    throw new Error(`the configuration "${key}" has an invalid value "${result}". it should be boolean`);
-  }
-  listConfig() {
-    const store = this.store;
-    return store;
-  }
-  invalidateCache() {
-    this._store = undefined;
-  }
-  getGlobalStore(): Store {
-    return {
-      list: () => this.globalConfig.toPlainObject(),
-      set: (key: string, value: string) => this.globalConfig.set(key, value),
-      del: (key: string) => this.globalConfig.delete(key),
-      write: async () => this.globalConfig.write(),
-      invalidateCache: async () => this._globalConfig = undefined,
-      getPath: () => getGlobalConfigPath(),
-    };
-  }
-}
-
-export const configGetter = new ConfigGetter();
-
-export function getConfig(key: string): string | undefined {
-  return configGetter.getConfig(key);
-}
-export function getNumberFromConfig(key: string): number | undefined {
-  return configGetter.getConfigNumeric(key);
-}
-export function listConfig(): Record<string, string> {
-  return configGetter.listConfig();
-}
-/**
- * @deprecated use setConfig from the ConfigStore aspect instance
- */
-export function setGlobalConfig(key: string, val: string) {
-  const globalStore = configGetter.getGlobalStore();
-  globalStore.set(key, val);
-  configGetter.globalConfig.writeSync();
-  globalStore.invalidateCache().catch(() => {});
-  configGetter.invalidateCache();
-}
-/**
- * @deprecated use delConfig from the ConfigStore aspect instance
- */
-export function delGlobalConfig(key: string) {
-  const globalStore = configGetter.getGlobalStore();
-  globalStore.del(key);
-  configGetter.globalConfig.writeSync();
-  globalStore.invalidateCache().catch(() => {});
-  configGetter.invalidateCache();
-}
-
-function toEnvVariableName(configName: string): string {
-  return `${ENV_VARIABLE_CONFIG_PREFIX}${configName.replace(/\./g, '_').toUpperCase()}`;
-}

package/config-store.aspect.ts

@@ -1,6 +0,0 @@
-import { Aspect } from '@teambit/harmony';
-
-export const ConfigStoreAspect = Aspect.create({
-  id: 'teambit.harmony/config-store',
-});
-  

package/config-store.main.runtime.ts

@@ -1,89 +0,0 @@
-import { CLIAspect, CLIMain, MainRuntime } from '@teambit/cli';
-import { compact } from 'lodash';
-import { ConfigStoreAspect } from './config-store.aspect';
-import { configGetter, Store } from './config-getter';
-import { ConfigCmd } from './config-cmd';
-
-export type StoreOrigin = 'scope' | 'workspace' | 'global';
-
-export class ConfigStoreMain {
-  private _stores: { [origin: string]: Store } | undefined;
-  get stores (): { [origin: string]: Store } {
-    if (!this._stores) {
-      this._stores = {
-        global: configGetter.getGlobalStore()
-      };
-    }
-    return this._stores;
-  }
-  addStore(origin: StoreOrigin, store: Store) {
-    this.stores[origin] = store;
-    configGetter.addStore(store);
-  }
-  /**
-   * "global" must be first. the rest doesn't matter. can be scope or workspace.
-   */
-  getStoresOrdered(): Store[] {
-    return compact([this.stores.global, this.stores.workspace, this.stores.scope].filter(Boolean)) as Store[];
-  }
-  invalidateCache() {
-    configGetter.invalidateCache();
-    const stores = this.getStoresOrdered();
-    stores.forEach((store) => {
-      configGetter.addStore(store);
-    });
-  }
-  async invalidateAllStoresCaches() {
-    configGetter.invalidateCache();
-    const stores = this.getStoresOrdered();
-    for await (const store of stores) {
-      await store.invalidateCache();
-      configGetter.addStore(store);
-    };
-  }
-  async setConfig(key: string, value: string, origin: StoreOrigin = 'global') {
-    const store = this.stores[origin];
-    if (!store) throw new Error(`unable to set config, "${origin}" origin is missing`);
-    store.set(key, value);
-    await store.write();
-    await this.invalidateCache();
-  }
-  getConfig(key: string): string | undefined {
-    return configGetter.getConfig(key);
-  }
-  getConfigBoolean(key: string): boolean | undefined {
-    return configGetter.getConfigBoolean(key);
-  }
-  getConfigNumeric(key: string): number | undefined {
-    return configGetter.getConfigNumeric(key);
-  }
-  async delConfig(key: string, origin?: StoreOrigin) {
-    const getOrigin = () => {
-      if (origin) return origin;
-      return Object.keys(this.stores).find(originName => key in this.stores[originName].list());
-    }
-    const foundOrigin = getOrigin();
-    if (!foundOrigin) return; // if the key is not found in any store (or given store), nothing to do.
-    const store = this.stores[foundOrigin];
-    store.del(key);
-    await store.write();
-    await this.invalidateCache();
-  }
-  listConfig() {
-    return configGetter.listConfig();
-  }
-
-  static slots = [];
-  static dependencies = [CLIAspect];
-  static runtime = MainRuntime;
-  static async provider([cli]: [CLIMain]) {
-    const configStore = new ConfigStoreMain();
-    cli.register(new ConfigCmd(configStore));
-    return configStore;
-
-  }
-}
-
-ConfigStoreAspect.addRuntime(ConfigStoreMain);
-
-export default ConfigStoreMain;

package/global-config.ts

@@ -1,69 +0,0 @@
-import fs from 'fs-extra';
-import * as path from 'path';
-
-import { GLOBAL_CONFIG, GLOBAL_CONFIG_FILE } from '@teambit/legacy.constants';
-
-export function getGlobalConfigPath() {
-  return path.join(GLOBAL_CONFIG, GLOBAL_CONFIG_FILE);
-}
-
-export class GlobalConfig extends Map<string, string> {
-  toPlainObject() {
-    return mapToObject(this);
-  }
-
-  toJson() {
-    return JSON.stringify(this.toPlainObject(), null, 2);
-  }
-
-  write() {
-    return fs.outputFile(getGlobalConfigPath(), this.toJson());
-  }
-
-  writeSync() {
-    return fs.outputFileSync(getGlobalConfigPath(), this.toJson());
-  }
-
-  static loadSync(): GlobalConfig {
-    const configPath = getGlobalConfigPath();
-    if (!fs.existsSync(configPath)) {
-      const config = new GlobalConfig([]);
-      config.writeSync();
-      return config;
-    }
-    const contents = fs.readFileSync(configPath);
-    return new GlobalConfig(Object.entries(JSON.parse(contents.toString())));
-  }
-
-  static async load(): Promise<GlobalConfig> {
-    const configPath = getGlobalConfigPath();
-    const exists = await fs.pathExists(configPath);
-    if (!exists) {
-      const config = new GlobalConfig([]);
-      await config.write();
-      return config;
-    }
-    const contents = await fs.readFile(configPath);
-    return new GlobalConfig(Object.entries(JSON.parse(contents.toString())));
-  }
-}
-
-/**
- * Cast a `Map` to a plain object.
- * Keys are being casted by invoking `toString` on each key.
- * @name mapToObject
- * @param {Map} map to cast
- * @returns {*} plain object
- * @example
- * ```js
- *  mapToObject(new Map([['key', 'val'], ['foo', 'bar']]));
- *  // => { key: 'val', foo: 'bar' }
- * ```
- */
-function mapToObject(map: Map<any, any>): { [key: string]: any } {
-  const object = {};
-  map.forEach((val, key) => {
-    object[key.toString()] = val;
-  });
-  return object;
-}

package/index.ts

@@ -1,6 +0,0 @@
-import { ConfigStoreAspect } from './config-store.aspect';
-
-export type { ConfigStoreMain } from './config-store.main.runtime';
-export default ConfigStoreAspect;
-export { ConfigStoreAspect };
-export { getConfig, getNumberFromConfig, listConfig, Store, setGlobalConfig, delGlobalConfig } from './config-getter';