@teambit/config 0.0.391 → 0.0.397

package/dist/config.aspect.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.ConfigAspect = exports.ConfigRuntime = void 0;
+exports.ConfigRuntime = exports.ConfigAspect = void 0;
 
 function _harmony() {
   const data = require("@teambit/harmony");

package/dist/config.d.ts

@@ -15,6 +15,16 @@ export declare class Config {
     get path(): PathOsBased | undefined;
     get config(): HostConfig | undefined;
     static loadIfExist(dirPath: PathOsBased): Promise<Config | undefined | any>;
+    /**
+     * Ensure the given directory has a workspace config
+     * Load if existing and create new if not
+     *
+     * @static
+     * @param {PathOsBasedAbsolute} dirPath
+     * @param {WorkspaceConfigFileProps} [workspaceConfigProps={} as any]
+     * @returns {Promise<WorkspaceConfig>}
+     * @memberof WorkspaceConfig
+     */
     static ensureWorkspace(dirPath: PathOsBasedAbsolute, workspaceConfigProps?: WorkspaceConfigFileProps, legacyInitProps?: LegacyInitProps): Promise<Config>;
     get extensions(): ExtensionDataList | undefined;
     extension(extensionId: string, ignoreVersion: boolean): ExtensionDataEntry | undefined;

package/dist/index.js

@@ -3,6 +3,12 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+Object.defineProperty(exports, "ComponentScopeDirMap", {
+  enumerable: true,
+  get: function () {
+    return _workspaceConfig().ComponentScopeDirMap;
+  }
+});
 Object.defineProperty(exports, "Config", {
   enumerable: true,
   get: function () {
@@ -21,12 +27,6 @@ Object.defineProperty(exports, "ConfigRuntime", {
     return _config2().ConfigRuntime;
   }
 });
-Object.defineProperty(exports, "ComponentScopeDirMap", {
-  enumerable: true,
-  get: function () {
-    return _workspaceConfig().ComponentScopeDirMap;
-  }
-});
 Object.defineProperty(exports, "getWorkspaceConfigTemplateParsed", {
   enumerable: true,
   get: function () {

package/dist/types.d.ts

@@ -4,7 +4,14 @@ import { SetExtensionOptions } from './config';
 export declare type WriteOptions = {
     dir?: PathOsBasedAbsolute;
 };
+/**
+ * An interface implemented by component host (workspace / scope) config file
+ * This used to be able to abstract the workspace/scope config.
+ */
 export interface HostConfig {
+    /**
+     * Path to the actual file
+     */
     path: PathOsBased;
     extensions: ExtensionDataList;
     extension: (extensionId: string, ignoreVersion: boolean) => ExtensionDataEntry;

package/dist/workspace-config.d.ts

@@ -61,15 +61,76 @@ export declare class WorkspaceConfig implements HostConfig {
     private loadExtensions;
     extension(extensionId: string, ignoreVersion: boolean): any;
     setExtension(extensionId: string, config: Record<string, any>, options: SetExtensionOptions): any;
+    /**
+     * Create an instance of the WorkspaceConfig by an instance of the legacy config
+     *
+     * @static
+     * @param {*} legacyConfig
+     * @returns
+     * @memberof WorkspaceConfig
+     */
     static fromLegacyConfig(legacyConfig: any): WorkspaceConfig;
+    /**
+     * Create an instance of the WorkspaceConfig by data
+     *
+     * @static
+     * @param {WorkspaceConfigFileProps} data
+     * @returns
+     * @memberof WorkspaceConfig
+     */
     static fromObject(data: WorkspaceConfigFileProps): WorkspaceConfig;
+    /**
+     * Create an instance of the WorkspaceConfig by the workspace config template and override values
+     *
+     * @static
+     * @param {WorkspaceConfigFileProps} data values to override in the default template
+     * @returns
+     * @memberof WorkspaceConfig
+     */
     static create(props: WorkspaceConfigFileProps, dirPath?: PathOsBasedAbsolute, legacyInitProps?: LegacyInitProps): Promise<WorkspaceConfig>;
+    /**
+     * Ensure the given directory has a workspace config
+     * Load if existing and create new if not
+     *
+     * @static
+     * @param {PathOsBasedAbsolute} dirPath
+     * @param {WorkspaceConfigFileProps} [workspaceConfigProps={} as any]
+     * @returns {Promise<WorkspaceConfig>}
+     * @memberof WorkspaceConfig
+     */
     static ensure(dirPath: PathOsBasedAbsolute, workspaceConfigProps?: WorkspaceConfigFileProps, legacyInitProps?: LegacyInitProps): Promise<WorkspaceConfig>;
+    /**
+     * A function that register to the legacy ensure function in order to transform old props structure
+     * to the new one
+     * @param dirPath
+     * @param standAlone
+     * @param legacyWorkspaceConfigProps
+     */
     static onLegacyEnsure(dirPath: PathOsBasedAbsolute, standAlone: boolean, legacyWorkspaceConfigProps?: LegacyWorkspaceConfigProps): Promise<WorkspaceConfig>;
     static reset(dirPath: PathOsBasedAbsolute, resetHard: boolean): Promise<void>;
+    /**
+     * Get the path of the bit.jsonc file by a containing folder
+     *
+     * @static
+     * @param {PathOsBased} dirPath containing dir of the bit.jsonc file
+     * @returns {PathOsBased}
+     * @memberof WorkspaceConfig
+     */
     static composeWorkspaceJsoncPath(dirPath: PathOsBased): PathOsBased;
     static pathHasWorkspaceJsonc(dirPath: PathOsBased): Promise<boolean>;
+    /**
+     * Check if the given dir has workspace config (new or legacy)
+     * @param dirPath
+     */
     static isExist(dirPath: PathOsBased): Promise<boolean | undefined>;
+    /**
+     * Load the workspace configuration if it's exist
+     *
+     * @static
+     * @param {PathOsBased} dirPath
+     * @returns {(Promise<WorkspaceConfig | undefined>)}
+     * @memberof WorkspaceConfig
+     */
     static loadIfExist(dirPath: PathOsBased): Promise<WorkspaceConfig | undefined>;
     static _loadFromWorkspaceJsonc(workspaceJsoncPath: PathOsBased): Promise<WorkspaceConfig>;
     write({ dir }: {

package/dist/workspace-config.js

@@ -7,10 +7,10 @@ require("core-js/modules/es.promise.js");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.transformLegacyPropsToExtensions = transformLegacyPropsToExtensions;
+exports.WorkspaceConfig = void 0;
 exports.getWorkspaceConfigTemplateParsed = getWorkspaceConfigTemplateParsed;
 exports.stringifyWorkspaceConfig = stringifyWorkspaceConfig;
-exports.WorkspaceConfig = void 0;
+exports.transformLegacyPropsToExtensions = transformLegacyPropsToExtensions;
 
 function _defineProperty2() {
   const data = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/config",
-  "version": "0.0.391",
+  "version": "0.0.397",
   "homepage": "https://bit.dev/teambit/harmony/config",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.harmony",
     "name": "config",
-    "version": "0.0.391"
+    "version": "0.0.397"
   },
   "dependencies": {
     "@teambit/harmony": "0.2.11",
@@ -16,8 +16,8 @@
     "chalk": "2.4.2",
     "@babel/runtime": "7.12.18",
     "core-js": "^3.0.0",
-    "@teambit/cli": "0.0.380",
-    "@teambit/bit-error": "0.0.366"
+    "@teambit/cli": "0.0.386",
+    "@teambit/bit-error": "0.0.372"
   },
   "devDependencies": {
     "@types/fs-extra": "9.0.7",
@@ -30,7 +30,7 @@
     "@types/node": "12.20.4"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.76",
+    "@teambit/legacy": "1.0.172",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },
@@ -58,7 +58,7 @@
         "react": "-"
       },
       "peerDependencies": {
-        "@teambit/legacy": "1.0.76",
+        "@teambit/legacy": "1.0.172",
         "react-dom": "^16.8.0 || ^17.0.0",
         "react": "^16.8.0 || ^17.0.0"
       }

package/tsconfig.json

@@ -25,7 +25,6 @@
     "strict": true,
     "noImplicitAny": false,
     "rootDir": ".",
-    "removeComments": true,
     "preserveConstEnums": true,
     "resolveJsonModule": true
   },