@teambit/readme 0.0.1

package/dist/index.js

@@ -0,0 +1,44 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "ReadmeAspect", {
+  enumerable: true,
+  get: function () {
+    return _readme().ReadmeAspect;
+  }
+});
+Object.defineProperty(exports, "ReadmeEnv", {
+  enumerable: true,
+  get: function () {
+    return _readme2().ReadmeEnv;
+  }
+});
+exports.default = void 0;
+
+function _readme() {
+  const data = require("./readme.aspect");
+
+  _readme = function () {
+    return data;
+  };
+
+  return data;
+}
+
+function _readme2() {
+  const data = require("./readme.env");
+
+  _readme2 = function () {
+    return data;
+  };
+
+  return data;
+}
+
+var _default = _readme().ReadmeAspect;
+
+exports.default = _default;
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["index.ts"],"names":["ReadmeAspect"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAIA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;eAFeA,sB","sourcesContent":["import { ReadmeAspect } from './readme.aspect';\n\nexport default ReadmeAspect;\nexport type { ReadmeMain } from './readme.main.runtime';\nexport { ReadmeEnv } from './readme.env';\n\nexport { ReadmeAspect };\n"]}

package/dist/readme.aspect.d.ts

@@ -0,0 +1,2 @@
+import { Aspect } from '@teambit/harmony';
+export declare const ReadmeAspect: Aspect;

package/dist/readme.aspect.js

@@ -0,0 +1,24 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ReadmeAspect = void 0;
+
+function _harmony() {
+  const data = require("@teambit/harmony");
+
+  _harmony = function () {
+    return data;
+  };
+
+  return data;
+}
+
+const ReadmeAspect = _harmony().Aspect.create({
+  id: 'teambit.mdx/readme'
+});
+
+exports.ReadmeAspect = ReadmeAspect;
+
+//# sourceMappingURL=readme.aspect.js.map

package/dist/readme.aspect.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["readme.aspect.ts"],"names":["ReadmeAspect","Aspect","create","id"],"mappings":";;;;;;;AAAA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAEO,MAAMA,YAAY,GAAGC,kBAAOC,MAAP,CAAc;AACxCC,EAAAA,EAAE,EAAE;AADoC,CAAd,CAArB","sourcesContent":["import { Aspect } from '@teambit/harmony';\n\nexport const ReadmeAspect = Aspect.create({\n  id: 'teambit.mdx/readme',\n});\n"]}

package/dist/readme.env.d.ts

@@ -0,0 +1,14 @@
+import { Component } from '@teambit/component';
+import { Environment } from '@teambit/envs';
+import { DocsMain } from '@teambit/docs';
+export declare const ReadmeEnvType = "readme";
+export declare class ReadmeEnv implements Environment {
+    private docs;
+    constructor(docs: DocsMain);
+    private getNegateDocsDevPatterns;
+    getDocsDevPatterns(component: Component): string[];
+    getDevPatterns(component?: Component): string[];
+    __getDescriptor(): Promise<{
+        type: string;
+    }>;
+}

package/dist/readme.env.js

@@ -0,0 +1,39 @@
+"use strict";
+
+require("core-js/modules/es.promise.js");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ReadmeEnvType = exports.ReadmeEnv = void 0;
+const ReadmeEnvType = 'readme';
+exports.ReadmeEnvType = ReadmeEnvType;
+
+class ReadmeEnv {
+  constructor(docs) {
+    this.docs = docs;
+  }
+
+  getNegateDocsDevPatterns() {
+    return this.docs.getPatterns().map(pattern => `!${pattern}`);
+  }
+
+  getDocsDevPatterns(component) {
+    return this.getDevPatterns(component).concat(this.getNegateDocsDevPatterns());
+  }
+
+  getDevPatterns(component) {
+    return component && component.mainFile.relative ? [component.mainFile.relative] : ['index.*'];
+  }
+
+  async __getDescriptor() {
+    return {
+      type: 'readme'
+    };
+  }
+
+}
+
+exports.ReadmeEnv = ReadmeEnv;
+
+//# sourceMappingURL=readme.env.js.map

package/dist/readme.env.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["readme.env.ts"],"names":["ReadmeEnvType","ReadmeEnv","constructor","docs","getNegateDocsDevPatterns","getPatterns","map","pattern","getDocsDevPatterns","component","getDevPatterns","concat","mainFile","relative","__getDescriptor","type"],"mappings":";;;;;;;;AAIO,MAAMA,aAAa,GAAG,QAAtB;;;AAEA,MAAMC,SAAN,CAAuC;AAC5CC,EAAAA,WAAW,CAASC,IAAT,EAAyB;AAAA,SAAhBA,IAAgB,GAAhBA,IAAgB;AAAE;;AAC9BC,EAAAA,wBAAwB,GAAa;AAC3C,WAAO,KAAKD,IAAL,CAAUE,WAAV,GAAwBC,GAAxB,CAA6BC,OAAD,IAAc,IAAGA,OAAQ,EAArD,CAAP;AACD;;AACDC,EAAAA,kBAAkB,CAACC,SAAD,EAAiC;AACjD,WAAO,KAAKC,cAAL,CAAoBD,SAApB,EAA+BE,MAA/B,CAAsC,KAAKP,wBAAL,EAAtC,CAAP;AACD;;AACDM,EAAAA,cAAc,CAACD,SAAD,EAAkC;AAC9C,WAAOA,SAAS,IAAIA,SAAS,CAACG,QAAV,CAAmBC,QAAhC,GAA2C,CAACJ,SAAS,CAACG,QAAV,CAAmBC,QAApB,CAA3C,GAA2E,CAAC,SAAD,CAAlF;AACD;;AACoB,QAAfC,eAAe,GAAG;AACtB,WAAO;AACLC,MAAAA,IAAI,EAAE;AADD,KAAP;AAGD;;AAf2C","sourcesContent":["import { Component } from '@teambit/component';\nimport { Environment } from '@teambit/envs';\nimport { DocsMain } from '@teambit/docs';\n\nexport const ReadmeEnvType = 'readme';\n\nexport class ReadmeEnv implements Environment {\n  constructor(private docs: DocsMain) {}\n  private getNegateDocsDevPatterns(): string[] {\n    return this.docs.getPatterns().map((pattern) => `!${pattern}`);\n  }\n  getDocsDevPatterns(component: Component): string[] {\n    return this.getDevPatterns(component).concat(this.getNegateDocsDevPatterns());\n  }\n  getDevPatterns(component?: Component): string[] {\n    return component && component.mainFile.relative ? [component.mainFile.relative] : ['index.*'];\n  }\n  async __getDescriptor() {\n    return {\n      type: 'readme',\n    };\n  }\n}\n"]}

package/dist/readme.main.runtime.d.ts

@@ -0,0 +1,13 @@
+import { EnvsMain } from '@teambit/envs';
+import { MdxEnv, MDXMain } from '@teambit/mdx';
+import { DocsMain } from '@teambit/docs';
+import { ReadmeEnv } from './readme.env';
+export declare class ReadmeMain {
+    protected env: ReadmeEnv & MdxEnv;
+    private docs;
+    static runtime: import("@teambit/harmony").RuntimeDefinition;
+    static dependencies: import("@teambit/harmony").Aspect[];
+    constructor(env: ReadmeEnv & MdxEnv, docs: DocsMain);
+    icon(): string;
+    static provider([envs, mdx, docs]: [EnvsMain, MDXMain, DocsMain]): Promise<ReadmeMain>;
+}

package/dist/readme.main.runtime.js

@@ -0,0 +1,109 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+require("core-js/modules/es.array.iterator.js");
+
+require("core-js/modules/es.promise.js");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ReadmeMain = void 0;
+
+function _defineProperty2() {
+  const data = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+  _defineProperty2 = function () {
+    return data;
+  };
+
+  return data;
+}
+
+function _envs() {
+  const data = require("@teambit/envs");
+
+  _envs = function () {
+    return data;
+  };
+
+  return data;
+}
+
+function _cli() {
+  const data = require("@teambit/cli");
+
+  _cli = function () {
+    return data;
+  };
+
+  return data;
+}
+
+function _mdx() {
+  const data = _interopRequireDefault(require("@teambit/mdx"));
+
+  _mdx = function () {
+    return data;
+  };
+
+  return data;
+}
+
+function _docs() {
+  const data = _interopRequireDefault(require("@teambit/docs"));
+
+  _docs = function () {
+    return data;
+  };
+
+  return data;
+}
+
+function _readme() {
+  const data = require("./readme.aspect");
+
+  _readme = function () {
+    return data;
+  };
+
+  return data;
+}
+
+function _readme2() {
+  const data = require("./readme.env");
+
+  _readme2 = function () {
+    return data;
+  };
+
+  return data;
+}
+
+class ReadmeMain {
+  constructor(env, docs) {
+    this.env = env;
+    this.docs = docs;
+  }
+
+  icon() {
+    return 'https://static.bit.dev/bit-icons/file-text.svg';
+  }
+
+  static async provider([envs, mdx, docs]) {
+    const readmeEnv = envs.merge(new (_readme2().ReadmeEnv)(docs), mdx.mdxEnv);
+    envs.registerEnv(readmeEnv);
+    const readme = new ReadmeMain(readmeEnv, docs);
+    return readme;
+  }
+
+}
+
+exports.ReadmeMain = ReadmeMain;
+(0, _defineProperty2().default)(ReadmeMain, "runtime", _cli().MainRuntime);
+(0, _defineProperty2().default)(ReadmeMain, "dependencies", [_envs().EnvsAspect, _mdx().default, _docs().default]);
+
+_readme().ReadmeAspect.addRuntime(ReadmeMain);
+
+//# sourceMappingURL=readme.main.runtime.js.map

package/dist/readme.main.runtime.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["readme.main.runtime.ts"],"names":["ReadmeMain","constructor","env","docs","icon","provider","envs","mdx","readmeEnv","merge","ReadmeEnv","mdxEnv","registerEnv","readme","MainRuntime","EnvsAspect","MDXAspect","DocsAspect","ReadmeAspect","addRuntime"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAEA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAEO,MAAMA,UAAN,CAAiB;AAGtBC,EAAAA,WAAW,CAAWC,GAAX,EAA4CC,IAA5C,EAA4D;AAAA,SAAjDD,GAAiD,GAAjDA,GAAiD;AAAA,SAAhBC,IAAgB,GAAhBA,IAAgB;AAAE;;AACzEC,EAAAA,IAAI,GAAG;AACL,WAAO,gDAAP;AACD;;AACoB,eAARC,QAAQ,CAAC,CAACC,IAAD,EAAOC,GAAP,EAAYJ,IAAZ,CAAD,EAAmD;AACtE,UAAMK,SAAS,GAAGF,IAAI,CAACG,KAAL,CAA8B,KAAIC,oBAAJ,EAAcP,IAAd,CAA9B,EAAmDI,GAAG,CAACI,MAAvD,CAAlB;AACAL,IAAAA,IAAI,CAACM,WAAL,CAAiBJ,SAAjB;AACA,UAAMK,MAAM,GAAG,IAAIb,UAAJ,CAAeQ,SAAf,EAA0BL,IAA1B,CAAf;AACA,WAAOU,MAAP;AACD;;AAZqB;;;gCAAXb,U,aACMc,kB;gCADNd,U,kBAEW,CAACe,kBAAD,EAAaC,cAAb,EAAwBC,eAAxB,C;;AAaxBC,uBAAaC,UAAb,CAAwBnB,UAAxB","sourcesContent":["import { EnvsAspect, EnvsMain } from '@teambit/envs';\nimport { MainRuntime } from '@teambit/cli';\nimport MDXAspect, { MdxEnv, MDXMain } from '@teambit/mdx';\nimport DocsAspect, { DocsMain } from '@teambit/docs';\n\nimport { ReadmeAspect } from './readme.aspect';\nimport { ReadmeEnv } from './readme.env';\n\nexport class ReadmeMain {\n  static runtime = MainRuntime;\n  static dependencies = [EnvsAspect, MDXAspect, DocsAspect];\n  constructor(protected env: ReadmeEnv & MdxEnv, private docs: DocsMain) {}\n  icon() {\n    return 'https://static.bit.dev/bit-icons/file-text.svg';\n  }\n  static async provider([envs, mdx, docs]: [EnvsMain, MDXMain, DocsMain]) {\n    const readmeEnv = envs.merge<ReadmeEnv, MdxEnv>(new ReadmeEnv(docs), mdx.mdxEnv);\n    envs.registerEnv(readmeEnv);\n    const readme = new ReadmeMain(readmeEnv, docs);\n    return readme;\n  }\n}\n\nReadmeAspect.addRuntime(ReadmeMain);\n"]}

package/overview-1650916592801.js

@@ -0,0 +1,14 @@
+
+import { linkModules } from '/home/circleci/bit/bit/node_modules/@teambit/preview/dist/preview.preview.runtime.js';
+import harmony from '/home/circleci/bit/bit/node_modules/@teambit/harmony/dist/index.js';
+import * as mainModule from '/home/circleci/bit/bit/node_modules/@teambit/react.ui.docs-app/dist/index.js';
+
+
+
+linkModules('overview', {
+  mainModule,
+  isSplitComponentBundle: true,
+  componentMap: {
+
+  }
+});

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "@teambit/readme",
+  "version": "0.0.1",
+  "main": "dist/index.js",
+  "componentId": {
+    "scope": "teambit.mdx",
+    "name": "readme",
+    "version": "0.0.1"
+  },
+  "dependencies": {
+    "@babel/runtime": "7.12.18",
+    "core-js": "^3.0.0",
+    "@teambit/harmony": "0.3.3",
+    "@teambit/component": "0.0.717",
+    "@teambit/docs": "0.0.717",
+    "@teambit/envs": "0.0.717",
+    "@teambit/cli": "0.0.477",
+    "@teambit/mdx": "0.0.697"
+  },
+  "devDependencies": {
+    "@types/mocha": "9.1.0",
+    "@types/testing-library__jest-dom": "5.9.5",
+    "@types/jest": "^26.0.0",
+    "@types/react-dom": "^17.0.5",
+    "@types/react": "^17.0.8",
+    "@types/node": "12.20.4"
+  },
+  "peerDependencies": {
+    "@teambit/legacy": "1.0.257",
+    "react-dom": "^16.8.0 || ^17.0.0",
+    "react": "^16.8.0 || ^17.0.0"
+  },
+  "license": "Apache-2.0",
+  "bit": {
+    "bindingPrefix": "@teambit",
+    "env": {},
+    "overrides": {
+      "dependencies": {
+        "@teambit/legacy": "-",
+        "@babel/runtime": "7.12.18",
+        "core-js": "^3.0.0",
+        "react-dom": "-",
+        "react": "-"
+      },
+      "devDependencies": {
+        "@teambit/legacy": "-",
+        "@types/mocha": "9.1.0",
+        "@types/testing-library__jest-dom": "5.9.5",
+        "@types/jest": "^26.0.0",
+        "@types/react-dom": "^17.0.5",
+        "@types/react": "^17.0.8",
+        "@types/node": "12.20.4",
+        "react-dom": "-",
+        "react": "-"
+      },
+      "peerDependencies": {
+        "@teambit/legacy": "1.0.257",
+        "react-dom": "^16.8.0 || ^17.0.0",
+        "react": "^16.8.0 || ^17.0.0"
+      }
+    }
+  },
+  "private": false,
+  "engines": {
+    "node": ">=12.22.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/teambit/bit"
+  },
+  "keywords": [
+    "bit",
+    "bit-aspect",
+    "components",
+    "collaboration",
+    "web",
+    "react",
+    "react-components",
+    "angular",
+    "angular-components",
+    "vue",
+    "vue-components"
+  ]
+}

package/preview-1650916592801.js

@@ -0,0 +1 @@
+

package/readme.aspect.ts

@@ -0,0 +1,5 @@
+import { Aspect } from '@teambit/harmony';
+
+export const ReadmeAspect = Aspect.create({
+  id: 'teambit.mdx/readme',
+});

package/readme.env.ts

@@ -0,0 +1,23 @@
+import { Component } from '@teambit/component';
+import { Environment } from '@teambit/envs';
+import { DocsMain } from '@teambit/docs';
+
+export const ReadmeEnvType = 'readme';
+
+export class ReadmeEnv implements Environment {
+  constructor(private docs: DocsMain) {}
+  private getNegateDocsDevPatterns(): string[] {
+    return this.docs.getPatterns().map((pattern) => `!${pattern}`);
+  }
+  getDocsDevPatterns(component: Component): string[] {
+    return this.getDevPatterns(component).concat(this.getNegateDocsDevPatterns());
+  }
+  getDevPatterns(component?: Component): string[] {
+    return component && component.mainFile.relative ? [component.mainFile.relative] : ['index.*'];
+  }
+  async __getDescriptor() {
+    return {
+      type: 'readme',
+    };
+  }
+}

package/readme.main.runtime.ts

@@ -0,0 +1,24 @@
+import { EnvsAspect, EnvsMain } from '@teambit/envs';
+import { MainRuntime } from '@teambit/cli';
+import MDXAspect, { MdxEnv, MDXMain } from '@teambit/mdx';
+import DocsAspect, { DocsMain } from '@teambit/docs';
+
+import { ReadmeAspect } from './readme.aspect';
+import { ReadmeEnv } from './readme.env';
+
+export class ReadmeMain {
+  static runtime = MainRuntime;
+  static dependencies = [EnvsAspect, MDXAspect, DocsAspect];
+  constructor(protected env: ReadmeEnv & MdxEnv, private docs: DocsMain) {}
+  icon() {
+    return 'https://static.bit.dev/bit-icons/file-text.svg';
+  }
+  static async provider([envs, mdx, docs]: [EnvsMain, MDXMain, DocsMain]) {
+    const readmeEnv = envs.merge<ReadmeEnv, MdxEnv>(new ReadmeEnv(docs), mdx.mdxEnv);
+    envs.registerEnv(readmeEnv);
+    const readme = new ReadmeMain(readmeEnv, docs);
+    return readme;
+  }
+}
+
+ReadmeAspect.addRuntime(ReadmeMain);

package/tsconfig.json

@@ -0,0 +1,35 @@
+{
+  "compilerOptions": {
+    "lib": [
+      "es2019",
+      "DOM",
+      "ES6",
+      "DOM.Iterable",
+      "ScriptHost"
+    ],
+    "target": "es2015",
+    "module": "commonjs",
+    "jsx": "react",
+    "allowJs": true,
+    "composite": true,
+    "declaration": true,
+    "sourceMap": true,
+    "skipLibCheck": true,
+    "outDir": "dist",
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "rootDir": ".",
+    "resolveJsonModule": true,
+    "emitDeclarationOnly": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "allowSyntheticDefaultImports": true,
+    "strictPropertyInitialization": false,
+    "strict": true,
+    "noImplicitAny": false,
+    "preserveConstEnums": true
+  },
+  "exclude": [
+    "dist"
+  ]
+}

package/types/asset.d.ts

@@ -0,0 +1,29 @@
+declare module '*.png' {
+  const value: any;
+  export = value;
+}
+declare module '*.svg' {
+  import type { FunctionComponent, SVGProps } from 'react';
+
+  export const ReactComponent: FunctionComponent<SVGProps<SVGSVGElement> & { title?: string }>;
+  const src: string;
+  export default src;
+}
+
+// @TODO Gilad
+declare module '*.jpg' {
+  const value: any;
+  export = value;
+}
+declare module '*.jpeg' {
+  const value: any;
+  export = value;
+}
+declare module '*.gif' {
+  const value: any;
+  export = value;
+}
+declare module '*.bmp' {
+  const value: any;
+  export = value;
+}

package/types/style.d.ts

@@ -0,0 +1,42 @@
+declare module '*.module.css' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+declare module '*.module.scss' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+declare module '*.module.sass' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.module.less' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.less' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.css' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.sass' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.scss' {
+  const classes: { readonly [key: string]: string };
+  export default classes;
+}
+
+declare module '*.mdx' {
+  const component: any;
+  export default component;
+}