@teambit/dependencies.aspect-docs.yarn 0.0.0-9a8a63f109a18e1dd237e7b6e40f0ae94957e2ce
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/dist/index.d.ts +1 -0
- package/dist/index.js +9 -0
- package/dist/index.js.map +1 -0
- package/dist/preview-1755618052181.js +7 -0
- package/dist/yarn.composition.d.ts +2 -0
- package/dist/yarn.composition.js +15 -0
- package/dist/yarn.composition.js.map +1 -0
- package/dist/yarn.docs.mdx +34 -0
- package/dist/yarn.mdx.js +43 -0
- package/dist/yarn.mdx.js.map +1 -0
- package/index.ts +1 -0
- package/package.json +52 -0
- package/types/asset.d.ts +29 -0
- package/types/style.d.ts +42 -0
- package/yarn.composition.tsx +12 -0
- package/yarn.docs.mdx +34 -0
- package/yarn.mdx +21 -0
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { default as Yarn } from './yarn.mdx';
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.Yarn = void 0;
|
|
7
|
+
var yarn_mdx_1 = require("./yarn.mdx");
|
|
8
|
+
Object.defineProperty(exports, "Yarn", { enumerable: true, get: function () { return __importDefault(yarn_mdx_1).default; } });
|
|
9
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;AAAA,uCAA6C;AAApC,iHAAA,OAAO,OAAQ"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.dependencies_aspect-docs_yarn@9a8a63f109a18e1dd237e7b6e40f0ae94957e2ce/dist/yarn.composition.js';
|
|
2
|
+
import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.dependencies_aspect-docs_yarn@9a8a63f109a18e1dd237e7b6e40f0ae94957e2ce/dist/yarn.docs.mdx';
|
|
3
|
+
|
|
4
|
+
export const compositions = [compositions_0];
|
|
5
|
+
export const overview = [overview_0];
|
|
6
|
+
|
|
7
|
+
export const compositions_metadata = {"compositions":[{"displayName":"Yarn docs","identifier":"YarnDocs"}]};
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.YarnDocs = void 0;
|
|
7
|
+
const react_1 = __importDefault(require("react"));
|
|
8
|
+
const documenter_theme_theme_compositions_1 = require("@teambit/documenter.theme.theme-compositions");
|
|
9
|
+
const mdx_ui_mdx_layout_1 = require("@teambit/mdx.ui.mdx-layout");
|
|
10
|
+
const index_1 = require("./index");
|
|
11
|
+
const YarnDocs = () => (react_1.default.createElement(documenter_theme_theme_compositions_1.ThemeCompositions, null,
|
|
12
|
+
react_1.default.createElement(mdx_ui_mdx_layout_1.MDXLayout, null,
|
|
13
|
+
react_1.default.createElement(index_1.Yarn, null))));
|
|
14
|
+
exports.YarnDocs = YarnDocs;
|
|
15
|
+
//# sourceMappingURL=yarn.composition.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"yarn.composition.js","sourceRoot":"","sources":["../yarn.composition.tsx"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAC1B,sGAAiF;AACjF,kEAAuD;AACvD,mCAA+B;AAExB,MAAM,QAAQ,GAAG,GAAG,EAAE,CAAC,CAC5B,8BAAC,uDAAiB;IAChB,8BAAC,6BAAS;QACR,8BAAC,YAAI,OAAG,CACE,CACM,CACrB,CAAC;AANW,QAAA,QAAQ,YAMnB"}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: 'Docs for Yarn aspect'
|
|
3
|
+
labels: ['docs', 'aspect', 'extensions']
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
import { Yarn } from './index';
|
|
7
|
+
|
|
8
|
+
## Static Content Page in MDX
|
|
9
|
+
|
|
10
|
+
Docs for Yarn aspect
|
|
11
|
+
|
|
12
|
+
### Component usage
|
|
13
|
+
|
|
14
|
+
Use your component in any mdx file:
|
|
15
|
+
|
|
16
|
+
```js
|
|
17
|
+
import { Yarn } from '@teambit/aspect-docs.yarn';
|
|
18
|
+
|
|
19
|
+
<Yarn />;
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
### Render with theme and MDX providers
|
|
23
|
+
|
|
24
|
+
```js
|
|
25
|
+
import { ThemeCompositions } from '@teambit/documenter.theme.theme-compositions';
|
|
26
|
+
import { MDXLayout } from '@teambit/ui.mdx-layout';
|
|
27
|
+
import { Yarn } from '@teambit/aspect-docs.yarn';
|
|
28
|
+
|
|
29
|
+
<ThemeCompositions>
|
|
30
|
+
<MDXLayout>
|
|
31
|
+
<Yarn />
|
|
32
|
+
</MDXLayout>
|
|
33
|
+
</ThemeCompositions>;
|
|
34
|
+
```
|
package/dist/yarn.mdx.js
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
exports["default"] = MDXContent;
|
|
7
|
+
var _react = _interopRequireDefault(require("react"));
|
|
8
|
+
var _react2 = require("@mdx-js/react");
|
|
9
|
+
var _excluded = ["components"]; // @ts-nocheck
|
|
10
|
+
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|
11
|
+
function _extends() { return _extends = Object.assign ? Object.assign.bind() : function (n) { for (var e = 1; e < arguments.length; e++) { var t = arguments[e]; for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]); } return n; }, _extends.apply(null, arguments); }
|
|
12
|
+
function _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var n = Object.getOwnPropertySymbols(e); for (r = 0; r < n.length; r++) o = n[r], -1 === t.indexOf(o) && {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }
|
|
13
|
+
function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }
|
|
14
|
+
/* @jsxRuntime classic */
|
|
15
|
+
/* @jsx mdx */
|
|
16
|
+
|
|
17
|
+
var layoutProps = {};
|
|
18
|
+
var MDXLayout = "wrapper";
|
|
19
|
+
function MDXContent(_ref) {
|
|
20
|
+
var components = _ref.components,
|
|
21
|
+
props = _objectWithoutProperties(_ref, _excluded);
|
|
22
|
+
return (0, _react2.mdx)(MDXLayout, _extends({}, layoutProps, props, {
|
|
23
|
+
components: components,
|
|
24
|
+
mdxType: "MDXLayout"
|
|
25
|
+
}), (0, _react2.mdx)("p", null, "Yarn is a Bit aspect that enables the use of the Yarn ", (0, _react2.mdx)("strong", {
|
|
26
|
+
parentName: "p"
|
|
27
|
+
}, "v2"), " package manager in a Bit workspace (the Yarn aspect utilizes Yarn's programmatic API).\nThe yarn aspect is used ", (0, _react2.mdx)("strong", {
|
|
28
|
+
parentName: "p"
|
|
29
|
+
}, "indirectly"), " by the 'Dependency Resolver'"), (0, _react2.mdx)("h2", null, "Quickstart"), (0, _react2.mdx)("p", null, "To start using the yarn aspect as a package manager for your workspace, set the Dependency Resolver ", (0, _react2.mdx)("inlineCode", {
|
|
30
|
+
parentName: "p"
|
|
31
|
+
}, "packageManager"), " property to 'yarn'."), (0, _react2.mdx)("pre", null, (0, _react2.mdx)("code", {
|
|
32
|
+
parentName: "pre",
|
|
33
|
+
"className": "language-json"
|
|
34
|
+
}, "{\n \"teambit.dependencies/dependency-resolver\": {\n \"packageManager\": \"teambit.dependencies/yarn\"\n }\n}\n")), (0, _react2.mdx)("blockquote", null, (0, _react2.mdx)("p", {
|
|
35
|
+
parentName: "blockquote"
|
|
36
|
+
}, "Package manager are only configurable at the workspace configuration root-level.\nThat means, different components in the same workspace cannot use different package manager.")), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("blockquote", null, (0, _react2.mdx)("p", {
|
|
37
|
+
parentName: "blockquote"
|
|
38
|
+
}, "Packages on NPM will be installed from Bit.dev's registry instead of NPM's. This will be done using the user's Bit credentials.")));
|
|
39
|
+
}
|
|
40
|
+
;
|
|
41
|
+
MDXContent.isMDXComponent = true;
|
|
42
|
+
|
|
43
|
+
//# sourceMappingURL=yarn.mdx.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"names":["_react","_interopRequireDefault","require","_react2","_excluded","e","__esModule","_extends","Object","assign","bind","n","arguments","length","t","r","hasOwnProperty","call","apply","_objectWithoutProperties","o","i","_objectWithoutPropertiesLoose","getOwnPropertySymbols","indexOf","propertyIsEnumerable","layoutProps","MDXLayout","MDXContent","_ref","components","props","mdx","mdxType","parentName","isMDXComponent"],"sourceRoot":"/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.dependencies_aspect-docs_yarn@9a8a63f109a18e1dd237e7b6e40f0ae94957e2ce","sources":["yarn.mdx.js"],"sourcesContent":["\n// @ts-nocheck\nimport React from 'react'\nimport { mdx } from '@mdx-js/react'\n\n/* @jsxRuntime classic */\n/* @jsx mdx */\n\n\n\n\nconst layoutProps = {\n \n};\nconst MDXLayout = \"wrapper\"\nexport default function MDXContent({\n components,\n ...props\n}) {\n return <MDXLayout {...layoutProps} {...props} components={components} mdxType=\"MDXLayout\">\n <p>{`Yarn is a Bit aspect that enables the use of the Yarn `}<strong parentName=\"p\">{`v2`}</strong>{` package manager in a Bit workspace (the Yarn aspect utilizes Yarn's programmatic API).\nThe yarn aspect is used `}<strong parentName=\"p\">{`indirectly`}</strong>{` by the 'Dependency Resolver'`}</p>\n <h2>{`Quickstart`}</h2>\n <p>{`To start using the yarn aspect as a package manager for your workspace, set the Dependency Resolver `}<inlineCode parentName=\"p\">{`packageManager`}</inlineCode>{` property to 'yarn'.`}</p>\n <pre><code parentName=\"pre\" {...{\n \"className\": \"language-json\"\n }}>{`{\n \"teambit.dependencies/dependency-resolver\": {\n \"packageManager\": \"teambit.dependencies/yarn\"\n }\n}\n`}</code></pre>\n <blockquote>\n <p parentName=\"blockquote\">{`Package manager are only configurable at the workspace configuration root-level.\nThat means, different components in the same workspace cannot use different package manager.`}</p>\n </blockquote>\n <hr></hr>\n <blockquote>\n <p parentName=\"blockquote\">{`Packages on NPM will be installed from Bit.dev's registry instead of NPM's. This will be done using the user's Bit credentials.`}</p>\n </blockquote>\n </MDXLayout>;\n}\n;\nMDXContent.isMDXComponent = true;"],"mappings":";;;;;;AAEA,IAAAA,MAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,OAAA,GAAAD,OAAA;AAAmC,IAAAE,SAAA,mBAFnC;AAAA,SAAAH,uBAAAI,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,gBAAAA,CAAA;AAAA,SAAAE,SAAA,WAAAA,QAAA,GAAAC,MAAA,CAAAC,MAAA,GAAAD,MAAA,CAAAC,MAAA,CAAAC,IAAA,eAAAC,CAAA,aAAAN,CAAA,MAAAA,CAAA,GAAAO,SAAA,CAAAC,MAAA,EAAAR,CAAA,UAAAS,CAAA,GAAAF,SAAA,CAAAP,CAAA,YAAAU,CAAA,IAAAD,CAAA,OAAAE,cAAA,CAAAC,IAAA,CAAAH,CAAA,EAAAC,CAAA,MAAAJ,CAAA,CAAAI,CAAA,IAAAD,CAAA,CAAAC,CAAA,aAAAJ,CAAA,KAAAJ,QAAA,CAAAW,KAAA,OAAAN,SAAA;AAAA,SAAAO,yBAAAd,CAAA,EAAAS,CAAA,gBAAAT,CAAA,iBAAAe,CAAA,EAAAL,CAAA,EAAAM,CAAA,GAAAC,6BAAA,CAAAjB,CAAA,EAAAS,CAAA,OAAAN,MAAA,CAAAe,qBAAA,QAAAZ,CAAA,GAAAH,MAAA,CAAAe,qBAAA,CAAAlB,CAAA,QAAAU,CAAA,MAAAA,CAAA,GAAAJ,CAAA,CAAAE,MAAA,EAAAE,CAAA,IAAAK,CAAA,GAAAT,CAAA,CAAAI,CAAA,UAAAD,CAAA,CAAAU,OAAA,CAAAJ,CAAA,QAAAK,oBAAA,CAAAR,IAAA,CAAAZ,CAAA,EAAAe,CAAA,MAAAC,CAAA,CAAAD,CAAA,IAAAf,CAAA,CAAAe,CAAA,aAAAC,CAAA;AAAA,SAAAC,8BAAAP,CAAA,EAAAV,CAAA,gBAAAU,CAAA,iBAAAD,CAAA,gBAAAH,CAAA,IAAAI,CAAA,SAAAC,cAAA,CAAAC,IAAA,CAAAF,CAAA,EAAAJ,CAAA,gBAAAN,CAAA,CAAAmB,OAAA,CAAAb,CAAA,aAAAG,CAAA,CAAAH,CAAA,IAAAI,CAAA,CAAAJ,CAAA,YAAAG,CAAA;AAIA;AACA;;AAKA,IAAMY,WAAW,GAAG,CAEpB,CAAC;AACD,IAAMC,SAAS,GAAG,SAAS;AACZ,SAASC,UAAUA,CAAAC,IAAA,EAG/B;EAAA,IAFDC,UAAU,GAAAD,IAAA,CAAVC,UAAU;IACPC,KAAK,GAAAZ,wBAAA,CAAAU,IAAA,EAAAzB,SAAA;EAER,OAAO,IAAAD,OAAA,CAAA6B,GAAA,EAACL,SAAS,EAAApB,QAAA,KAAKmB,WAAW,EAAMK,KAAK;IAAED,UAAU,EAAEA,UAAW;IAACG,OAAO,EAAC;EAAW,IACvF,IAAA9B,OAAA,CAAA6B,GAAA,uEAA6D,IAAA7B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAG,OAAe,CAAC,uHAC7E,IAAA/B,OAAA,CAAA6B,GAAA;IAAQE,UAAU,EAAC;EAAG,eAAuB,CAAC,iCAAoC,CAAC,EACzG,IAAA/B,OAAA,CAAA6B,GAAA,0BAAsB,CAAC,EACvB,IAAA7B,OAAA,CAAA6B,GAAA,qHAA2G,IAAA7B,OAAA,CAAA6B,GAAA;IAAYE,UAAU,EAAC;EAAG,mBAA+B,CAAC,wBAA2B,CAAC,EACjM,IAAA/B,OAAA,CAAA6B,GAAA,eAAK,IAAA7B,OAAA,CAAA6B,GAAA;IAAME,UAAU,EAAC,KAAK;IACvB,WAAW,EAAE;EAAe,0HAM5B,CAAM,CAAC,EACX,IAAA/B,OAAA,CAAA6B,GAAA,sBACE,IAAA7B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAY,mLACiE,CACjF,CAAC,EACb,IAAA/B,OAAA,CAAA6B,GAAA,YAAQ,CAAC,EACT,IAAA7B,OAAA,CAAA6B,GAAA,sBACE,IAAA7B,OAAA,CAAA6B,GAAA;IAAGE,UAAU,EAAC;EAAY,oIAAuI,CACvJ,CACD,CAAC;AAChB;AACA;AACAN,UAAU,CAACO,cAAc,GAAG,IAAI","ignoreList":[]}
|
package/index.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { default as Yarn } from './yarn.mdx';
|
package/package.json
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@teambit/dependencies.aspect-docs.yarn",
|
|
3
|
+
"version": "0.0.0-9a8a63f109a18e1dd237e7b6e40f0ae94957e2ce",
|
|
4
|
+
"homepage": "https://bit.cloud/teambit/dependencies/aspect-docs/yarn",
|
|
5
|
+
"main": "dist/index.js",
|
|
6
|
+
"componentId": {
|
|
7
|
+
"scope": "teambit.dependencies",
|
|
8
|
+
"name": "aspect-docs/yarn",
|
|
9
|
+
"version": "9a8a63f109a18e1dd237e7b6e40f0ae94957e2ce"
|
|
10
|
+
},
|
|
11
|
+
"dependencies": {
|
|
12
|
+
"core-js": "^3.0.0",
|
|
13
|
+
"@mdx-js/react": "1.6.22",
|
|
14
|
+
"@teambit/mdx.ui.mdx-scope-context": "1.0.0"
|
|
15
|
+
},
|
|
16
|
+
"devDependencies": {
|
|
17
|
+
"@types/react": "^17.0.8",
|
|
18
|
+
"@types/mocha": "9.1.0",
|
|
19
|
+
"@types/node": "12.20.4",
|
|
20
|
+
"@types/react-dom": "^17.0.5",
|
|
21
|
+
"@types/jest": "^26.0.0",
|
|
22
|
+
"@babel/runtime": "7.20.0",
|
|
23
|
+
"@types/testing-library__jest-dom": "5.9.5",
|
|
24
|
+
"@teambit/documenter.theme.theme-compositions": "4.1.5",
|
|
25
|
+
"@teambit/mdx.ui.mdx-layout": "1.0.11"
|
|
26
|
+
},
|
|
27
|
+
"peerDependencies": {
|
|
28
|
+
"react": "^16.8.0 || ^17.0.0",
|
|
29
|
+
"react-dom": "^16.8.0 || ^17.0.0"
|
|
30
|
+
},
|
|
31
|
+
"license": "Apache-2.0",
|
|
32
|
+
"optionalDependencies": {},
|
|
33
|
+
"peerDependenciesMeta": {},
|
|
34
|
+
"private": false,
|
|
35
|
+
"engines": {
|
|
36
|
+
"node": ">=12.22.0"
|
|
37
|
+
},
|
|
38
|
+
"repository": {
|
|
39
|
+
"type": "git",
|
|
40
|
+
"url": "https://github.com/teambit/bit"
|
|
41
|
+
},
|
|
42
|
+
"keywords": [
|
|
43
|
+
"bit",
|
|
44
|
+
"components",
|
|
45
|
+
"collaboration",
|
|
46
|
+
"web",
|
|
47
|
+
"react",
|
|
48
|
+
"react-components",
|
|
49
|
+
"angular",
|
|
50
|
+
"angular-components"
|
|
51
|
+
]
|
|
52
|
+
}
|
package/types/asset.d.ts
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
declare module '*.png' {
|
|
2
|
+
const value: any;
|
|
3
|
+
export = value;
|
|
4
|
+
}
|
|
5
|
+
declare module '*.svg' {
|
|
6
|
+
import type { FunctionComponent, SVGProps } from 'react';
|
|
7
|
+
|
|
8
|
+
export const ReactComponent: FunctionComponent<SVGProps<SVGSVGElement> & { title?: string }>;
|
|
9
|
+
const src: string;
|
|
10
|
+
export default src;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
// @TODO Gilad
|
|
14
|
+
declare module '*.jpg' {
|
|
15
|
+
const value: any;
|
|
16
|
+
export = value;
|
|
17
|
+
}
|
|
18
|
+
declare module '*.jpeg' {
|
|
19
|
+
const value: any;
|
|
20
|
+
export = value;
|
|
21
|
+
}
|
|
22
|
+
declare module '*.gif' {
|
|
23
|
+
const value: any;
|
|
24
|
+
export = value;
|
|
25
|
+
}
|
|
26
|
+
declare module '*.bmp' {
|
|
27
|
+
const value: any;
|
|
28
|
+
export = value;
|
|
29
|
+
}
|
package/types/style.d.ts
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
declare module '*.module.css' {
|
|
2
|
+
const classes: { readonly [key: string]: string };
|
|
3
|
+
export default classes;
|
|
4
|
+
}
|
|
5
|
+
declare module '*.module.scss' {
|
|
6
|
+
const classes: { readonly [key: string]: string };
|
|
7
|
+
export default classes;
|
|
8
|
+
}
|
|
9
|
+
declare module '*.module.sass' {
|
|
10
|
+
const classes: { readonly [key: string]: string };
|
|
11
|
+
export default classes;
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
declare module '*.module.less' {
|
|
15
|
+
const classes: { readonly [key: string]: string };
|
|
16
|
+
export default classes;
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
declare module '*.less' {
|
|
20
|
+
const classes: { readonly [key: string]: string };
|
|
21
|
+
export default classes;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
declare module '*.css' {
|
|
25
|
+
const classes: { readonly [key: string]: string };
|
|
26
|
+
export default classes;
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
declare module '*.sass' {
|
|
30
|
+
const classes: { readonly [key: string]: string };
|
|
31
|
+
export default classes;
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
declare module '*.scss' {
|
|
35
|
+
const classes: { readonly [key: string]: string };
|
|
36
|
+
export default classes;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
declare module '*.mdx' {
|
|
40
|
+
const component: any;
|
|
41
|
+
export default component;
|
|
42
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import React from 'react';
|
|
2
|
+
import { ThemeCompositions } from '@teambit/documenter.theme.theme-compositions';
|
|
3
|
+
import { MDXLayout } from '@teambit/mdx.ui.mdx-layout';
|
|
4
|
+
import { Yarn } from './index';
|
|
5
|
+
|
|
6
|
+
export const YarnDocs = () => (
|
|
7
|
+
<ThemeCompositions>
|
|
8
|
+
<MDXLayout>
|
|
9
|
+
<Yarn />
|
|
10
|
+
</MDXLayout>
|
|
11
|
+
</ThemeCompositions>
|
|
12
|
+
);
|
package/yarn.docs.mdx
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: 'Docs for Yarn aspect'
|
|
3
|
+
labels: ['docs', 'aspect', 'extensions']
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
import { Yarn } from './index';
|
|
7
|
+
|
|
8
|
+
## Static Content Page in MDX
|
|
9
|
+
|
|
10
|
+
Docs for Yarn aspect
|
|
11
|
+
|
|
12
|
+
### Component usage
|
|
13
|
+
|
|
14
|
+
Use your component in any mdx file:
|
|
15
|
+
|
|
16
|
+
```js
|
|
17
|
+
import { Yarn } from '@teambit/aspect-docs.yarn';
|
|
18
|
+
|
|
19
|
+
<Yarn />;
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
### Render with theme and MDX providers
|
|
23
|
+
|
|
24
|
+
```js
|
|
25
|
+
import { ThemeCompositions } from '@teambit/documenter.theme.theme-compositions';
|
|
26
|
+
import { MDXLayout } from '@teambit/ui.mdx-layout';
|
|
27
|
+
import { Yarn } from '@teambit/aspect-docs.yarn';
|
|
28
|
+
|
|
29
|
+
<ThemeCompositions>
|
|
30
|
+
<MDXLayout>
|
|
31
|
+
<Yarn />
|
|
32
|
+
</MDXLayout>
|
|
33
|
+
</ThemeCompositions>;
|
|
34
|
+
```
|
package/yarn.mdx
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
Yarn is a Bit aspect that enables the use of the Yarn **v2** package manager in a Bit workspace (the Yarn aspect utilizes Yarn's programmatic API).
|
|
2
|
+
The yarn aspect is used **indirectly** by the 'Dependency Resolver'
|
|
3
|
+
|
|
4
|
+
## Quickstart
|
|
5
|
+
|
|
6
|
+
To start using the yarn aspect as a package manager for your workspace, set the Dependency Resolver `packageManager` property to 'yarn'.
|
|
7
|
+
|
|
8
|
+
```json
|
|
9
|
+
{
|
|
10
|
+
"teambit.dependencies/dependency-resolver": {
|
|
11
|
+
"packageManager": "teambit.dependencies/yarn"
|
|
12
|
+
}
|
|
13
|
+
}
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
> Package manager are only configurable at the workspace configuration root-level.
|
|
17
|
+
> That means, different components in the same workspace cannot use different package manager.
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
> Packages on NPM will be installed from Bit.dev's registry instead of NPM's. This will be done using the user's Bit credentials.
|