@teambit/envs 1.0.226 → 1.0.228
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/artifacts/__bit_junit.xml +1 -1
- package/artifacts/preview/teambit_envs_envs-preview.js +1 -1
- package/artifacts/schema.json +492 -2065
- package/dist/{preview-1712632644937.js → preview-1712805335812.js} +2 -2
- package/package.json +24 -24
- package/tsconfig.json +64 -1
- package/dist/context/context.d.ts +0 -44
- package/dist/context/index.d.ts +0 -1
- package/dist/env-definition.d.ts +0 -41
- package/dist/env-interface.d.ts +0 -4
- package/dist/env-service-list.d.ts +0 -35
- package/dist/env.composition.d.ts +0 -1
- package/dist/env.fragment.d.ts +0 -17
- package/dist/env.plugin.d.ts +0 -18
- package/dist/environment.d.ts +0 -196
- package/dist/environments.aspect.d.ts +0 -2
- package/dist/environments.graphql.d.ts +0 -3
- package/dist/environments.main.runtime.d.ts +0 -320
- package/dist/envs.cmd.d.ts +0 -51
- package/dist/exceptions/env-not-configured-for-component.d.ts +0 -4
- package/dist/exceptions/env-not-found-in-runtime.d.ts +0 -5
- package/dist/exceptions/env-not-found.d.ts +0 -6
- package/dist/exceptions/index.d.ts +0 -3
- package/dist/index.d.ts +0 -16
- package/dist/runtime/env-runtime.d.ts +0 -41
- package/dist/runtime/envs-execution-result.d.ts +0 -18
- package/dist/runtime/index.d.ts +0 -2
- package/dist/runtime/runtime.d.ts +0 -49
- package/dist/services/concrete-service.d.ts +0 -8
- package/dist/services/index.d.ts +0 -4
- package/dist/services/service-handler-context.d.ts +0 -30
- package/dist/services/service-handler.d.ts +0 -18
- package/dist/services/service.d.ts +0 -66
@@ -1,5 +1,5 @@
|
|
1
|
-
import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.envs_envs@1.0.
|
2
|
-
import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.envs_envs@1.0.
|
1
|
+
import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.envs_envs@1.0.228/dist/env.composition.js';
|
2
|
+
import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.envs_envs@1.0.228/dist/envs.docs.mdx';
|
3
3
|
|
4
4
|
export const compositions = [compositions_0];
|
5
5
|
export const overview = [overview_0];
|
package/package.json
CHANGED
@@ -1,12 +1,12 @@
|
|
1
1
|
{
|
2
2
|
"name": "@teambit/envs",
|
3
|
-
"version": "1.0.
|
3
|
+
"version": "1.0.228",
|
4
4
|
"homepage": "https://bit.cloud/teambit/envs/envs",
|
5
5
|
"main": "dist/index.js",
|
6
6
|
"componentId": {
|
7
7
|
"scope": "teambit.envs",
|
8
8
|
"name": "envs",
|
9
|
-
"version": "1.0.
|
9
|
+
"version": "1.0.228"
|
10
10
|
},
|
11
11
|
"dependencies": {
|
12
12
|
"chalk": "2.4.2",
|
@@ -18,28 +18,28 @@
|
|
18
18
|
"@teambit/harmony": "0.4.6",
|
19
19
|
"@teambit/bit-error": "0.0.404",
|
20
20
|
"@teambit/component-id": "1.2.0",
|
21
|
-
"@teambit/component": "1.0.
|
22
|
-
"@teambit/aspect-loader": "1.0.
|
23
|
-
"@teambit/cli": "0.0.
|
24
|
-
"@teambit/logger": "0.0.
|
25
|
-
"@teambit/worker": "0.0.
|
26
|
-
"@teambit/builder": "1.0.
|
27
|
-
"@teambit/bundler": "1.0.
|
28
|
-
"@teambit/compiler": "1.0.
|
29
|
-
"@teambit/dependency-resolver": "1.0.
|
30
|
-
"@teambit/formatter": "1.0.
|
31
|
-
"@teambit/isolator": "1.0.
|
32
|
-
"@teambit/linter": "1.0.
|
33
|
-
"@teambit/pkg": "1.0.
|
34
|
-
"@teambit/preview": "1.0.
|
35
|
-
"@teambit/schema": "1.0.
|
36
|
-
"@teambit/tester": "1.0.
|
37
|
-
"@teambit/typescript": "1.0.
|
38
|
-
"@teambit/webpack": "1.0.
|
39
|
-
"@teambit/graphql": "1.0.
|
40
|
-
"@teambit/bit": "1.6.
|
21
|
+
"@teambit/component": "1.0.228",
|
22
|
+
"@teambit/aspect-loader": "1.0.228",
|
23
|
+
"@teambit/cli": "0.0.861",
|
24
|
+
"@teambit/logger": "0.0.954",
|
25
|
+
"@teambit/worker": "0.0.1165",
|
26
|
+
"@teambit/builder": "1.0.228",
|
27
|
+
"@teambit/bundler": "1.0.228",
|
28
|
+
"@teambit/compiler": "1.0.228",
|
29
|
+
"@teambit/dependency-resolver": "1.0.228",
|
30
|
+
"@teambit/formatter": "1.0.228",
|
31
|
+
"@teambit/isolator": "1.0.228",
|
32
|
+
"@teambit/linter": "1.0.228",
|
33
|
+
"@teambit/pkg": "1.0.228",
|
34
|
+
"@teambit/preview": "1.0.228",
|
35
|
+
"@teambit/schema": "1.0.228",
|
36
|
+
"@teambit/tester": "1.0.228",
|
37
|
+
"@teambit/typescript": "1.0.228",
|
38
|
+
"@teambit/webpack": "1.0.228",
|
39
|
+
"@teambit/graphql": "1.0.228",
|
40
|
+
"@teambit/bit": "1.6.121",
|
41
41
|
"@teambit/component-issues": "0.0.143",
|
42
|
-
"@teambit/issues": "1.0.
|
42
|
+
"@teambit/issues": "1.0.228",
|
43
43
|
"@teambit/toolbox.array.duplications-finder": "0.0.1",
|
44
44
|
"@teambit/cli-table": "0.0.48"
|
45
45
|
},
|
@@ -47,7 +47,7 @@
|
|
47
47
|
"@types/lodash": "4.14.165",
|
48
48
|
"@types/mocha": "9.1.0",
|
49
49
|
"chai": "4.3.0",
|
50
|
-
"@teambit/harmony.envs.core-aspect-env": "0.0.
|
50
|
+
"@teambit/harmony.envs.core-aspect-env": "0.0.30",
|
51
51
|
"@teambit/envs.aspect-docs.envs": "0.0.167"
|
52
52
|
},
|
53
53
|
"peerDependencies": {
|
package/tsconfig.json
CHANGED
@@ -20,7 +20,8 @@
|
|
20
20
|
"emitDeclarationOnly": true,
|
21
21
|
"strict": true,
|
22
22
|
"strictPropertyInitialization": false,
|
23
|
-
"noImplicitAny": false
|
23
|
+
"noImplicitAny": false,
|
24
|
+
"composite": true
|
24
25
|
},
|
25
26
|
"exclude": [
|
26
27
|
"artifacts",
|
@@ -35,5 +36,67 @@
|
|
35
36
|
"include": [
|
36
37
|
"**/*",
|
37
38
|
"**/*.json"
|
39
|
+
],
|
40
|
+
"references": [
|
41
|
+
{
|
42
|
+
"path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_component@1.0.228"
|
43
|
+
},
|
44
|
+
{
|
45
|
+
"path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_aspect-loader@1.0.228"
|
46
|
+
},
|
47
|
+
{
|
48
|
+
"path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_cli@0.0.861"
|
49
|
+
},
|
50
|
+
{
|
51
|
+
"path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_logger@0.0.954"
|
52
|
+
},
|
53
|
+
{
|
54
|
+
"path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_worker@0.0.1165"
|
55
|
+
},
|
56
|
+
{
|
57
|
+
"path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.pipelines_builder@1.0.228"
|
58
|
+
},
|
59
|
+
{
|
60
|
+
"path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.compilation_bundler@1.0.228"
|
61
|
+
},
|
62
|
+
{
|
63
|
+
"path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.compilation_compiler@1.0.228"
|
64
|
+
},
|
65
|
+
{
|
66
|
+
"path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.defender_formatter@1.0.228"
|
67
|
+
},
|
68
|
+
{
|
69
|
+
"path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_isolator@1.0.228"
|
70
|
+
},
|
71
|
+
{
|
72
|
+
"path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.defender_linter@1.0.228"
|
73
|
+
},
|
74
|
+
{
|
75
|
+
"path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.pkg_pkg@1.0.228"
|
76
|
+
},
|
77
|
+
{
|
78
|
+
"path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.preview_preview@1.0.228"
|
79
|
+
},
|
80
|
+
{
|
81
|
+
"path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.semantics_schema@1.0.228"
|
82
|
+
},
|
83
|
+
{
|
84
|
+
"path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.defender_tester@1.0.228"
|
85
|
+
},
|
86
|
+
{
|
87
|
+
"path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.typescript_typescript@1.0.228"
|
88
|
+
},
|
89
|
+
{
|
90
|
+
"path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.webpack_webpack@1.0.228"
|
91
|
+
},
|
92
|
+
{
|
93
|
+
"path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_graphql@1.0.228"
|
94
|
+
},
|
95
|
+
{
|
96
|
+
"path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_bit@1.6.121"
|
97
|
+
},
|
98
|
+
{
|
99
|
+
"path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_issues@1.0.228"
|
100
|
+
}
|
38
101
|
]
|
39
102
|
}
|
@@ -1,44 +0,0 @@
|
|
1
|
-
import { EnvDefinition } from '../env-definition';
|
2
|
-
import { Environment } from '../environment';
|
3
|
-
import { EnvRuntime, Runtime } from '../runtime';
|
4
|
-
export type ServiceMap<T> = {
|
5
|
-
[env: string]: T;
|
6
|
-
};
|
7
|
-
export declare class ExecutionContext {
|
8
|
-
/**
|
9
|
-
* upper scope of all environment contexts.
|
10
|
-
*/
|
11
|
-
readonly upper: Runtime;
|
12
|
-
/**
|
13
|
-
* runtime instance of the environment.
|
14
|
-
*/
|
15
|
-
readonly envRuntime: EnvRuntime;
|
16
|
-
/**
|
17
|
-
* components applied in the execution context.
|
18
|
-
*/
|
19
|
-
components: import("@teambit/component").Component[];
|
20
|
-
constructor(
|
21
|
-
/**
|
22
|
-
* upper scope of all environment contexts.
|
23
|
-
*/
|
24
|
-
upper: Runtime,
|
25
|
-
/**
|
26
|
-
* runtime instance of the environment.
|
27
|
-
*/
|
28
|
-
envRuntime: EnvRuntime,
|
29
|
-
/**
|
30
|
-
* components applied in the execution context.
|
31
|
-
*/
|
32
|
-
components?: import("@teambit/component").Component[]);
|
33
|
-
relatedContexts: string[];
|
34
|
-
/**
|
35
|
-
* extension ID of the environment
|
36
|
-
*/
|
37
|
-
get id(): string;
|
38
|
-
/**
|
39
|
-
* environment instance.
|
40
|
-
*/
|
41
|
-
get env(): Environment;
|
42
|
-
get envDefinition(): EnvDefinition;
|
43
|
-
apply<T>(name: string, args: any[]): T;
|
44
|
-
}
|
package/dist/context/index.d.ts
DELETED
@@ -1 +0,0 @@
|
|
1
|
-
export { ExecutionContext } from './context';
|
package/dist/env-definition.d.ts
DELETED
@@ -1,41 +0,0 @@
|
|
1
|
-
import { Environment } from './environment';
|
2
|
-
/**
|
3
|
-
* API for component development environment.
|
4
|
-
*/
|
5
|
-
export declare class EnvDefinition {
|
6
|
-
/**
|
7
|
-
* id of the env.
|
8
|
-
*/
|
9
|
-
readonly id: string;
|
10
|
-
/**
|
11
|
-
* env instance.
|
12
|
-
*/
|
13
|
-
readonly env: Environment;
|
14
|
-
constructor(
|
15
|
-
/**
|
16
|
-
* id of the env.
|
17
|
-
*/
|
18
|
-
id: string,
|
19
|
-
/**
|
20
|
-
* env instance.
|
21
|
-
*/
|
22
|
-
env: Environment);
|
23
|
-
/**
|
24
|
-
* get icon of the env.
|
25
|
-
*/
|
26
|
-
get icon(): string;
|
27
|
-
/**
|
28
|
-
* get the name of the env.
|
29
|
-
*/
|
30
|
-
get name(): string | undefined;
|
31
|
-
/**
|
32
|
-
* get the description of the env.
|
33
|
-
*/
|
34
|
-
get description(): string | undefined;
|
35
|
-
toObject(): {
|
36
|
-
id: string;
|
37
|
-
description: string | undefined;
|
38
|
-
name: string | undefined;
|
39
|
-
icon: string;
|
40
|
-
};
|
41
|
-
}
|
package/dist/env-interface.d.ts
DELETED
@@ -1,35 +0,0 @@
|
|
1
|
-
import { EnvDefinition } from './env-definition';
|
2
|
-
import { EnvService } from './services';
|
3
|
-
export declare class EnvServiceList {
|
4
|
-
/**
|
5
|
-
* environment
|
6
|
-
*/
|
7
|
-
readonly env: EnvDefinition;
|
8
|
-
/**
|
9
|
-
* services available on the env.
|
10
|
-
*/
|
11
|
-
readonly services: [string, EnvService<any>][];
|
12
|
-
constructor(
|
13
|
-
/**
|
14
|
-
* environment
|
15
|
-
*/
|
16
|
-
env: EnvDefinition,
|
17
|
-
/**
|
18
|
-
* services available on the env.
|
19
|
-
*/
|
20
|
-
services: [string, EnvService<any>][]);
|
21
|
-
toObject(): {
|
22
|
-
env: {
|
23
|
-
id: string;
|
24
|
-
description: string | undefined;
|
25
|
-
name: string | undefined;
|
26
|
-
icon: string;
|
27
|
-
};
|
28
|
-
services: {
|
29
|
-
id: string;
|
30
|
-
name: string | undefined;
|
31
|
-
description: string | undefined;
|
32
|
-
data: {} | Promise<{} | undefined> | undefined;
|
33
|
-
}[];
|
34
|
-
};
|
35
|
-
}
|
@@ -1 +0,0 @@
|
|
1
|
-
export declare const Logo: () => import("react/jsx-runtime").JSX.Element;
|
package/dist/env.fragment.d.ts
DELETED
@@ -1,17 +0,0 @@
|
|
1
|
-
import { ShowFragment, Component } from '@teambit/component';
|
2
|
-
import { EnvsMain } from './environments.main.runtime';
|
3
|
-
export declare class EnvFragment implements ShowFragment {
|
4
|
-
private envs;
|
5
|
-
constructor(envs: EnvsMain);
|
6
|
-
readonly title = "env";
|
7
|
-
renderRow(component: Component): Promise<{
|
8
|
-
title: string;
|
9
|
-
content: string;
|
10
|
-
}>;
|
11
|
-
json(component: Component): Promise<{
|
12
|
-
title: string;
|
13
|
-
json: string;
|
14
|
-
}>;
|
15
|
-
private getEnvId;
|
16
|
-
weight: number;
|
17
|
-
}
|
package/dist/env.plugin.d.ts
DELETED
@@ -1,18 +0,0 @@
|
|
1
|
-
import { PluginDefinition } from '@teambit/aspect-loader';
|
2
|
-
import { Aspect, Harmony } from '@teambit/harmony';
|
3
|
-
import { WorkerMain } from '@teambit/worker';
|
4
|
-
import { LoggerMain } from '@teambit/logger';
|
5
|
-
import { EnvsRegistry, ServicesRegistry } from './environments.main.runtime';
|
6
|
-
export declare class EnvPlugin implements PluginDefinition {
|
7
|
-
private envSlot;
|
8
|
-
private servicesRegistry;
|
9
|
-
private loggerMain;
|
10
|
-
private workerMain;
|
11
|
-
private harmony;
|
12
|
-
constructor(envSlot: EnvsRegistry, servicesRegistry: ServicesRegistry, loggerMain: LoggerMain, workerMain: WorkerMain, harmony: Harmony);
|
13
|
-
pattern: string;
|
14
|
-
runtimes: string[];
|
15
|
-
private createContext;
|
16
|
-
private transformToLegacyEnv;
|
17
|
-
register(object: any, aspect: Aspect): void;
|
18
|
-
}
|
package/dist/environment.d.ts
DELETED
@@ -1,196 +0,0 @@
|
|
1
|
-
import type { Linter, LinterContext } from '@teambit/linter';
|
2
|
-
import type { Formatter, FormatterContext } from '@teambit/formatter';
|
3
|
-
import type { Tester } from '@teambit/tester';
|
4
|
-
import type { Compiler } from '@teambit/compiler';
|
5
|
-
import type { Bundler, BundlerContext, DevServer, DevServerContext } from '@teambit/bundler';
|
6
|
-
import type { BuildTask } from '@teambit/builder';
|
7
|
-
import type { SchemaExtractor } from '@teambit/schema';
|
8
|
-
import type { WebpackConfigTransformer } from '@teambit/webpack';
|
9
|
-
import type { PackageJsonProps } from '@teambit/pkg';
|
10
|
-
import type { DependencyDetector, EnvPolicyConfigObject } from '@teambit/dependency-resolver';
|
11
|
-
import type { Capsule } from '@teambit/isolator';
|
12
|
-
import type { Component } from '@teambit/component';
|
13
|
-
import { EnvPreviewConfig } from '@teambit/preview';
|
14
|
-
import { SchemaNodeTransformer, SchemaTransformer } from '@teambit/typescript';
|
15
|
-
export type EnvDescriptor = {
|
16
|
-
type: string;
|
17
|
-
};
|
18
|
-
/**
|
19
|
-
* add a custom type and include all properties from within the environment.
|
20
|
-
*/
|
21
|
-
export interface Environment {
|
22
|
-
/**
|
23
|
-
* name of the environment.
|
24
|
-
*/
|
25
|
-
name?: string;
|
26
|
-
/**
|
27
|
-
* description of the environment.
|
28
|
-
*/
|
29
|
-
description?: string;
|
30
|
-
/**
|
31
|
-
* icon of the environment.
|
32
|
-
*/
|
33
|
-
icon?: string;
|
34
|
-
[key: string]: any;
|
35
|
-
/**
|
36
|
-
* Returns the Environment descriptor
|
37
|
-
* Required for any task
|
38
|
-
*/
|
39
|
-
__getDescriptor?: () => Promise<EnvDescriptor>;
|
40
|
-
/**
|
41
|
-
* Returns a schema generator instance
|
42
|
-
*/
|
43
|
-
getSchemaExtractor?: (config?: any, tsserverPath?: string, contextPath?: string, schemaTransformers?: SchemaTransformer[], apiTransformers?: SchemaNodeTransformer[]) => SchemaExtractor;
|
44
|
-
/**
|
45
|
-
* Returns the dev patterns to match doc files
|
46
|
-
*/
|
47
|
-
getDocsDevPatterns?: (component: Component) => string[];
|
48
|
-
/**
|
49
|
-
* Returns the dev patterns to match composition files
|
50
|
-
*/
|
51
|
-
getCompositionsDevPatterns?: (component: Component) => string[];
|
52
|
-
/**
|
53
|
-
* Returns additional dev patterns for the component.
|
54
|
-
* Patterns that were provided by getDocsDevPatterns, getTestsDevPatterns will be considered as dev files as well, without need to add them here.
|
55
|
-
*/
|
56
|
-
getDevPatterns?: (component: Component) => string[];
|
57
|
-
}
|
58
|
-
export interface DependenciesEnv extends Environment {
|
59
|
-
/**
|
60
|
-
* Returns the list of dependencies
|
61
|
-
* Required for any task
|
62
|
-
*/
|
63
|
-
getDependencies?: () => EnvPolicyConfigObject | Promise<EnvPolicyConfigObject>;
|
64
|
-
/**
|
65
|
-
* Returns a list of additional test host dependencies
|
66
|
-
* this will be added to the tester context
|
67
|
-
* This can be used in cases when you want specific dependencies to be resolved from the env during testing
|
68
|
-
* but you don't want these dependencies as peer dependencies of the component (as they are not used during runtime)
|
69
|
-
* An example for this is @angular/compiler, which during running tests you want to resolve from the env, but you don't
|
70
|
-
* need it during component runtime.
|
71
|
-
*/
|
72
|
-
getAdditionalTestHostDependencies?: () => string[] | Promise<string[]>;
|
73
|
-
/**
|
74
|
-
* Returns a list of additional host dependencies
|
75
|
-
* this list will be provided as globals on the window after bit preview bundle
|
76
|
-
* by default bit will merge this list with the peers from the getDependencies function
|
77
|
-
*/
|
78
|
-
getAdditionalHostDependencies?: () => string[] | Promise<string[]>;
|
79
|
-
/**
|
80
|
-
* Returns a list of dependency detectors
|
81
|
-
* this list will be used to detect all the dependencies in each file of the component
|
82
|
-
*/
|
83
|
-
getDepDetectors?: () => DependencyDetector[] | null;
|
84
|
-
}
|
85
|
-
export type GetNpmIgnoreContext = {
|
86
|
-
capsule: Capsule;
|
87
|
-
component: Component;
|
88
|
-
};
|
89
|
-
export interface PackageEnv extends Environment {
|
90
|
-
/**
|
91
|
-
* define the package json properties to add to each component.
|
92
|
-
* Used by `bit link` to augment package.json with new properties
|
93
|
-
*/
|
94
|
-
getPackageJsonProps?: () => PackageJsonProps;
|
95
|
-
/**
|
96
|
-
* return `.npmignore` entries to be written before packing the component
|
97
|
-
*/
|
98
|
-
getNpmIgnore?: (npmIgnoreContext?: GetNpmIgnoreContext) => string[];
|
99
|
-
}
|
100
|
-
export interface LinterEnv extends Environment {
|
101
|
-
/**
|
102
|
-
* Returns & configures the linter to use (ESLint, ...)
|
103
|
-
* Required for `bit lint`
|
104
|
-
*/
|
105
|
-
getLinter?: (context: LinterContext, transformers: any[]) => Linter;
|
106
|
-
}
|
107
|
-
export interface FormatterEnv extends Environment {
|
108
|
-
/**
|
109
|
-
* Returns & configures the formatter to use (prettier, ...)
|
110
|
-
* Required for `bit format`
|
111
|
-
*/
|
112
|
-
getFormatter?: (context: FormatterContext, transformers: any[]) => Formatter;
|
113
|
-
}
|
114
|
-
export interface PreviewEnv extends Environment {
|
115
|
-
/**
|
116
|
-
* Returns a paths to a function which mounts a given component to DOM
|
117
|
-
* Required for `bit start` & `bit build`
|
118
|
-
*/
|
119
|
-
getMounter?: () => string;
|
120
|
-
/**
|
121
|
-
* Returns a path to a docs template.
|
122
|
-
* Required for `bit start` & `bit build`
|
123
|
-
*/
|
124
|
-
getDocsTemplate?: () => string;
|
125
|
-
/**
|
126
|
-
* Returns a bundler for the preview.
|
127
|
-
* Required for `bit build` & `bit start`
|
128
|
-
*/
|
129
|
-
getBundler?: (context: BundlerContext, transformers: any[]) => Promise<Bundler>;
|
130
|
-
/**
|
131
|
-
* Returns preview config like the strategy name to use when bundling the components for the preview
|
132
|
-
*/
|
133
|
-
getPreviewConfig?: () => EnvPreviewConfig;
|
134
|
-
/**
|
135
|
-
* Returns a bundler for the env template.
|
136
|
-
* this bundler will be used to bundle the docs/compositions (or other preview) apps
|
137
|
-
* Required for `bit build` & `bit tag`
|
138
|
-
*/
|
139
|
-
getTemplateBundler?: (context: BundlerContext, transformers?: any[]) => Promise<Bundler>;
|
140
|
-
}
|
141
|
-
export type PipeServiceModifiersMap = Record<string, PipeServiceModifier>;
|
142
|
-
export interface PipeServiceModifier {
|
143
|
-
transformers?: Function[];
|
144
|
-
module?: any;
|
145
|
-
}
|
146
|
-
export interface BuilderEnv extends PreviewEnv {
|
147
|
-
/**
|
148
|
-
* @deprecated Fatal: a breaking API was introduced. Use getBuildPipe() instead.
|
149
|
-
*/
|
150
|
-
getPipe?: () => BuildTask[];
|
151
|
-
/**
|
152
|
-
* Returns the component build pipeline
|
153
|
-
* Either `getBuildPipe`, `getTagPipe`, or `getSnapPipe` is required for `bit build`
|
154
|
-
*/
|
155
|
-
getBuildPipe?: (modifiersMap?: PipeServiceModifiersMap) => BuildTask[];
|
156
|
-
/**
|
157
|
-
* Returns the component tag pipeline
|
158
|
-
* Either `getBuildPipe`, `getTagPipe`, or `getSnapPipe` is required for `bit build`
|
159
|
-
*/
|
160
|
-
getTagPipe?: (modifiersMap?: PipeServiceModifiersMap) => BuildTask[];
|
161
|
-
/**
|
162
|
-
* Returns the component snap pipeline
|
163
|
-
* Either `getBuildPipe`, `getTagPipe`, or `getSnapPipe` is required for `bit build`
|
164
|
-
*/
|
165
|
-
getSnapPipe?: (modifiersMap?: PipeServiceModifiersMap) => BuildTask[];
|
166
|
-
}
|
167
|
-
export interface TesterEnv extends Environment {
|
168
|
-
/**
|
169
|
-
* Returns a tester
|
170
|
-
* Required for `bit start` & `bit test`
|
171
|
-
*/
|
172
|
-
getTester?: (path: string, tester: any) => Tester;
|
173
|
-
/**
|
174
|
-
* Returns the dev patterns to match test files
|
175
|
-
*/
|
176
|
-
getTestsDevPatterns?: (component: Component) => string[];
|
177
|
-
}
|
178
|
-
export interface CompilerEnv {
|
179
|
-
/**
|
180
|
-
* Returns a compiler
|
181
|
-
* Required for making and reading dists, especially for `bit compile`
|
182
|
-
*/
|
183
|
-
getCompiler: () => Compiler;
|
184
|
-
}
|
185
|
-
export declare function hasCompiler(obj: Environment): obj is CompilerEnv;
|
186
|
-
export interface DevEnv extends PreviewEnv {
|
187
|
-
/**
|
188
|
-
* Required for `bit start`
|
189
|
-
*/
|
190
|
-
getDevEnvId?: (context?: any) => string;
|
191
|
-
/**
|
192
|
-
* Returns and configures the dev server
|
193
|
-
* Required for `bit start`
|
194
|
-
*/
|
195
|
-
getDevServer?: (context: DevServerContext, transformers: WebpackConfigTransformer[]) => DevServer | Promise<DevServer>;
|
196
|
-
}
|