@teambit/dev-files 1.0.225 → 1.0.227

Sign up to get free protection for your applications and to get access to all the features.
@@ -1,8 +1,8 @@
1
1
  <?xml version="1.0" encoding="UTF-8"?>
2
2
  <testsuites tests="3" failures="0" errors="0" skipped="0">
3
- <testsuite name="teambit.component/dev-files@1.0.225" tests="3" failures="0" errors="0" skipped="0">
3
+ <testsuite name="teambit.component/dev-files@1.0.227" tests="3" failures="0" errors="0" skipped="0">
4
4
  <testcase classname="dist/dev-files.spec.js" name="get all dev files of the docs aspect"/>
5
- <testcase classname="dist/dev-files.spec.js" name="should get undefined as there are no files for aspect id"/>
6
- <testcase classname="dist/dev-files.spec.js" name="should list all dev files" time="0.001"/>
5
+ <testcase classname="dist/dev-files.spec.js" name="should get undefined as there are no files for aspect id" time="0.001"/>
6
+ <testcase classname="dist/dev-files.spec.js" name="should list all dev files"/>
7
7
  </testsuite>
8
8
  </testsuites>
@@ -1 +1 @@
1
- !function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define([],t):"object"==typeof exports?exports["teambit.component/dev-files-preview"]=t():e["teambit.component/dev-files-preview"]=t()}(self,(()=>(()=>{"use strict";var e={93381:(e,t,n)=>{var o={id:"teambit.component/content/dev-files@1.95.9",homepage:"https://bit.dev/teambit/component/content/dev-files",exported:!0};Object.defineProperty(t,"__esModule",{value:!0}),t.default=u,s(n(41594));var r=n(5016),a=n(65682),i=["components"];function s(e){return e&&e.__esModule?e:{default:e}}function p(){return p=Object.assign||function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var o in n)Object.prototype.hasOwnProperty.call(n,o)&&(e[o]=n[o])}return e},p.apply(this,arguments)}function d(e,t){if(null==e)return{};var n,o,r=l(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o<a.length;o++)n=a[o],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}function l(e,t){if(null==e)return{};var n,o,r={},a=Object.keys(e);for(o=0;o<a.length;o++)n=a[o],t.indexOf(n)>=0||(r[n]=e[n]);return r}s.__bit_component=o,p.__bit_component=o,d.__bit_component=o,l.__bit_component=o;var c={},m="wrapper";function u(e){var t=e.components,n=d(e,i);return(0,r.mdx)(m,p({},c,n,{components:t,mdxType:"MDXLayout"}),(0,r.mdx)(a.MDXScopeProvider,{components:{},mdxType:"MDXScopeProvider"},(0,r.mdx)("h1",null,"Dev Files"),(0,r.mdx)("p",null,"Dev files are component files used for development and not for production. Dev files are determined as such by the Dev Files Aspect."),(0,r.mdx)("p",null,"Categorizing files as dev files is especially useful in dependency resolution, as dependencies can be inferred to be of type ",(0,r.mdx)("inlineCode",{parentName:"p"},"devDependencies")," by looking at the type of files that use them (if 'package-a' is only used by the component's dev files, then it is a dev dependency of that component)."),(0,r.mdx)("p",null,"For example, the ",(0,r.mdx)("inlineCode",{parentName:"p"},"ui/card")," component has the following file structure:"),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre"},"└── card\n ├── card.composition.tsx\n ├── card.docs.mdx\n ├── card.spec.tsx\n ├── card.tsx\n └── index.ts\n")),(0,r.mdx)("p",null,"To examine it:"),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre"},"$ bit show ui/card\n\n┌───────────────────┬──────────────────────────────────────────────────────────┐\n│ id │ company.scope/ui/card │\n├───────────────────┼──────────────────────────────────────────────────────────┤\n│ ... │ │\n├───────────────────┼──────────────────────────────────────────────────────────┤\n│ files │ card.composition.tsx │\n│ │ card.docs.mdx │\n│ │ card.spec.tsx │\n│ │ card.stories.tsx │\n│ │ card.tsx │\n│ │ index.ts │\n├───────────────────┼──────────────────────────────────────────────────────────┤\n│ dev files │ card.spec.tsx (teambit.defender/tester) │\n│ │ card.composition.tsx (teambit.compositions/compositions) │\n│ │ card.docs.mdx (teambit.docs/docs) │\n├───────────────────┼──────────────────────────────────────────────────────────┤\n│ extensions │ ... │\n├───────────────────┼──────────────────────────────────────────────────────────┤\n│ dependencies │ ... │\n├───────────────────┼──────────────────────────────────────────────────────────┤\n│ dev dependencies │ @company/scope.envs.my-react@0.0.1----- (component) │\n│ │ @types/testing-library__jest-dom@5.9.5- (package) │\n│ │ @babel/runtime@7.12.18----------------- (package) │\n│ │ @types/jest@^26.0.0-------------------- (package) │\n│ │ @types/react-dom@^17.0.5--------------- (package) │\n│ │ @types/react@^17.0.8------------------- (package) │\n│ │ @types/node@12.20.4-------------------- (package) │\n├───────────────────┼──────────────────────────────────────────────────────────┤\n│ peer dependencies │ ... │\n└───────────────────┴──────────────────────────────────────────────────────────┘\n")),(0,r.mdx)("p",null,"The component's compositions, documentation and test files are categorized as 'dev files'.\nTo the side of each listed dev file, you'll find the Aspect that registered it as such (via the Dev Files Aspect)."),(0,r.mdx)("p",null,"If, for example, ",(0,r.mdx)("inlineCode",{parentName:"p"},"@testing-library/react")," will be used by the test file, ",(0,r.mdx)("inlineCode",{parentName:"p"},"card.spec.tsx")," (and no other production file), it will be inferred as a dev dependency of that component."),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre",className:"language-tsx"},"// card.spec.tsx\n\nimport React from 'react';\nimport { render } from '@testing-library/react';\nimport { BasicCard } from './card.composition';\n\nit('should render a Heading', () => {\n const { getByText } = render(<BasicCard />);\n const rendered = getByText('Self Host');\n expect(rendered).toBeTruthy();\n});\n")),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre",className:"language-bash"},"$ bit show ui/card\n\n┌───────────────────┬──────────────────────────────────────────────────────────┐\n│ dev dependencies │ @company/scope.envs.my-react@0.0.1----- (component) │\n│ │ @types/testing-library__jest-dom@5.9.5- (package) │\n│ │ @babel/runtime@7.12.18----------------- (package) │\n│ │ @types/jest@^26.0.0-------------------- (package) │\n│ │ @types/react-dom@^17.0.5--------------- (package) │\n│ │ @types/react@^17.0.8------------------- (package) │\n│ │ @types/node@12.20.4-------------------- (package) │\n│ │ @testing-library/react@12.0.0---------- (package) │\n└───────────────────┴──────────────────────────────────────────────────────────┘\n")),(0,r.mdx)("h2",null,"Configuring Dev Files"),(0,r.mdx)("p",null,"Dev files are configured by setting glob patterns that match the files' names."),(0,r.mdx)("h3",null,"Setting Glob Patterns via ",(0,r.mdx)("inlineCode",{parentName:"h3"},"workspace.jsonc")),(0,r.mdx)("p",null,"Use the ",(0,r.mdx)("inlineCode",{parentName:"p"},"devFilePatterns")," property in ",(0,r.mdx)("inlineCode",{parentName:"p"},"teambit.component/dev-files")," to manually set a glob pattern for dev files."),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre",className:"language-json"},'{\n "teambit.workspace/variants": {\n "{ui/**}": {\n "teambit.component/dev-files": {\n "devFilePatterns": ["**/*.story.+(js|ts|jsx|tsx)"]\n }\n }\n }\n}\n')),(0,r.mdx)("h3",null,"Setting Glob Patterns via the Dev Files API"),(0,r.mdx)("p",null,"Update your extension or create an new one to register glob patterns for dev files, using the Dev Files ",(0,r.mdx)("inlineCode",{parentName:"p"},"registerDevPattern")," API."),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre"},"bit create aspect extensions/my-dev-files\n")),(0,r.mdx)("h4",null,"registerDevPattern"),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre",className:"language-ts"},"registerDevPattern: (pattern: string[]) : void\n")),(0,r.mdx)("p",null,"Use the ",(0,r.mdx)("inlineCode",{parentName:"p"},"registerDevPattern")," API to register an array of glob patterns."),(0,r.mdx)("p",null,"For example:"),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre",className:"language-ts"},"import { MainRuntime } from '@teambit/cli';\nimport { DevFilesAspect, DevFilesMain } from '@teambit/dev-files';\nimport { MyDevFilesAspect } from './my-dev-files.aspect';\n\nexport class MyDevFilesMain {\n constructor(private devFiles: DevFilesMain) {}\n\n static slots = [];\n\n static dependencies = [DevFilesAspect];\n\n static runtime = MainRuntime;\n\n static async provider([devFiles]: [DevFilesMain]) {\n devFiles.registerDevPattern(['**/*.my-dev.*']);\n\n return new MyDevFilesMain(devFiles);\n }\n}\n\nMyDevFilesAspect.addRuntime(MyDevFilesMain);\n")),(0,r.mdx)("p",null,"Configure the workspace config with that aspect to apply it on all components in the workspace:"),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre",className:"language-json"},'// workspace.jsonc\n{\n "company.scope/extensions/my-dev-files": {}\n}\n'))))}u.__bit_component=o,u.isMDXComponent=!0},40273:function(e,t,n){var o=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0}),t.default=t.DevFiles=void 0;var r=n(93381);Object.defineProperty(t,"DevFiles",{enumerable:!0,get:function(){return o(r).default}}),Object.defineProperty(t,"default",{enumerable:!0,get:function(){return o(r).default}})},55821:(e,t,n)=>{var o={id:"teambit.component/dev-files@1.0.225",homepage:"https://bit.cloud/teambit/component/dev-files",exported:!0};function r(){const e=a(n(41594));return r=function(){return e},e}function a(e){return e&&e.__esModule?e:{default:e}}Object.defineProperty(t,"__esModule",{value:!0}),t.Logo=void 0,r.__bit_component=o,a.__bit_component=o;const i=()=>r().default.createElement("div",{style:{height:"100%",display:"flex",justifyContent:"center"}},r().default.createElement("img",{style:{width:70},src:"https://static.bit.dev/extensions-icons/dev-files.svg"}));i.__bit_component=o,t.Logo=i},5016:e=>{e.exports=MdxJsReact},41594:e=>{e.exports=React},65682:e=>{e.exports=TeambitMdxUiMdxScopeContext}},t={};function n(o){var r=t[o];if(void 0!==r)return r.exports;var a=t[o]={exports:{}};return e[o].call(a.exports,a,a.exports,n),a.exports}n.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return n.d(t,{a:t}),t},n.d=(e,t)=>{for(var o in t)n.o(t,o)&&!n.o(e,o)&&Object.defineProperty(e,o,{enumerable:!0,get:t[o]})},n.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),n.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var o={};return(()=>{n.r(o),n.d(o,{compositions:()=>u,compositions_metadata:()=>v,overview:()=>f});var e={};n.r(e),n.d(e,{default:()=>m});var t=n(55821),r=(n(41594),n(5016)),a=n(65682),i=n(40273),s=n.n(i),p=["components"];function d(){return d=Object.assign?Object.assign.bind():function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var o in n)Object.prototype.hasOwnProperty.call(n,o)&&(e[o]=n[o])}return e},d.apply(this,arguments)}var l={},c="wrapper";function m(e){var t=e.components,n=function(e,t){if(null==e)return{};var n,o,r=function(e,t){if(null==e)return{};var n,o,r={},a=Object.keys(e);for(o=0;o<a.length;o++)n=a[o],t.indexOf(n)>=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o<a.length;o++)n=a[o],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}(e,p);return(0,r.mdx)(c,d({},l,n,{components:t,mdxType:"MDXLayout"}),(0,r.mdx)(a.MDXScopeProvider,{components:{DevFiles:s()},mdxType:"MDXScopeProvider"},(0,r.mdx)(s(),{mdxType:"DevFiles"})))}m.isMDXComponent=!0;const u=[t],f=[e],v={compositions:[{displayName:"Logo",identifier:"Logo"}]}})(),o})()));
1
+ !function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define([],t):"object"==typeof exports?exports["teambit.component/dev-files-preview"]=t():e["teambit.component/dev-files-preview"]=t()}(self,(()=>(()=>{"use strict";var e={50121:(e,t,n)=>{var o={id:"teambit.component/content/dev-files@1.95.9",homepage:"https://bit.dev/teambit/component/content/dev-files",exported:!0};Object.defineProperty(t,"__esModule",{value:!0}),t.default=u,s(n(41594));var r=n(5016),a=n(65682),i=["components"];function s(e){return e&&e.__esModule?e:{default:e}}function p(){return p=Object.assign||function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var o in n)Object.prototype.hasOwnProperty.call(n,o)&&(e[o]=n[o])}return e},p.apply(this,arguments)}function d(e,t){if(null==e)return{};var n,o,r=l(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o<a.length;o++)n=a[o],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}function l(e,t){if(null==e)return{};var n,o,r={},a=Object.keys(e);for(o=0;o<a.length;o++)n=a[o],t.indexOf(n)>=0||(r[n]=e[n]);return r}s.__bit_component=o,p.__bit_component=o,d.__bit_component=o,l.__bit_component=o;var c={},m="wrapper";function u(e){var t=e.components,n=d(e,i);return(0,r.mdx)(m,p({},c,n,{components:t,mdxType:"MDXLayout"}),(0,r.mdx)(a.MDXScopeProvider,{components:{},mdxType:"MDXScopeProvider"},(0,r.mdx)("h1",null,"Dev Files"),(0,r.mdx)("p",null,"Dev files are component files used for development and not for production. Dev files are determined as such by the Dev Files Aspect."),(0,r.mdx)("p",null,"Categorizing files as dev files is especially useful in dependency resolution, as dependencies can be inferred to be of type ",(0,r.mdx)("inlineCode",{parentName:"p"},"devDependencies")," by looking at the type of files that use them (if 'package-a' is only used by the component's dev files, then it is a dev dependency of that component)."),(0,r.mdx)("p",null,"For example, the ",(0,r.mdx)("inlineCode",{parentName:"p"},"ui/card")," component has the following file structure:"),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre"},"└── card\n ├── card.composition.tsx\n ├── card.docs.mdx\n ├── card.spec.tsx\n ├── card.tsx\n └── index.ts\n")),(0,r.mdx)("p",null,"To examine it:"),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre"},"$ bit show ui/card\n\n┌───────────────────┬──────────────────────────────────────────────────────────┐\n│ id │ company.scope/ui/card │\n├───────────────────┼──────────────────────────────────────────────────────────┤\n│ ... │ │\n├───────────────────┼──────────────────────────────────────────────────────────┤\n│ files │ card.composition.tsx │\n│ │ card.docs.mdx │\n│ │ card.spec.tsx │\n│ │ card.stories.tsx │\n│ │ card.tsx │\n│ │ index.ts │\n├───────────────────┼──────────────────────────────────────────────────────────┤\n│ dev files │ card.spec.tsx (teambit.defender/tester) │\n│ │ card.composition.tsx (teambit.compositions/compositions) │\n│ │ card.docs.mdx (teambit.docs/docs) │\n├───────────────────┼──────────────────────────────────────────────────────────┤\n│ extensions │ ... │\n├───────────────────┼──────────────────────────────────────────────────────────┤\n│ dependencies │ ... │\n├───────────────────┼──────────────────────────────────────────────────────────┤\n│ dev dependencies │ @company/scope.envs.my-react@0.0.1----- (component) │\n│ │ @types/testing-library__jest-dom@5.9.5- (package) │\n│ │ @babel/runtime@7.12.18----------------- (package) │\n│ │ @types/jest@^26.0.0-------------------- (package) │\n│ │ @types/react-dom@^17.0.5--------------- (package) │\n│ │ @types/react@^17.0.8------------------- (package) │\n│ │ @types/node@12.20.4-------------------- (package) │\n├───────────────────┼──────────────────────────────────────────────────────────┤\n│ peer dependencies │ ... │\n└───────────────────┴──────────────────────────────────────────────────────────┘\n")),(0,r.mdx)("p",null,"The component's compositions, documentation and test files are categorized as 'dev files'.\nTo the side of each listed dev file, you'll find the Aspect that registered it as such (via the Dev Files Aspect)."),(0,r.mdx)("p",null,"If, for example, ",(0,r.mdx)("inlineCode",{parentName:"p"},"@testing-library/react")," will be used by the test file, ",(0,r.mdx)("inlineCode",{parentName:"p"},"card.spec.tsx")," (and no other production file), it will be inferred as a dev dependency of that component."),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre",className:"language-tsx"},"// card.spec.tsx\n\nimport React from 'react';\nimport { render } from '@testing-library/react';\nimport { BasicCard } from './card.composition';\n\nit('should render a Heading', () => {\n const { getByText } = render(<BasicCard />);\n const rendered = getByText('Self Host');\n expect(rendered).toBeTruthy();\n});\n")),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre",className:"language-bash"},"$ bit show ui/card\n\n┌───────────────────┬──────────────────────────────────────────────────────────┐\n│ dev dependencies │ @company/scope.envs.my-react@0.0.1----- (component) │\n│ │ @types/testing-library__jest-dom@5.9.5- (package) │\n│ │ @babel/runtime@7.12.18----------------- (package) │\n│ │ @types/jest@^26.0.0-------------------- (package) │\n│ │ @types/react-dom@^17.0.5--------------- (package) │\n│ │ @types/react@^17.0.8------------------- (package) │\n│ │ @types/node@12.20.4-------------------- (package) │\n│ │ @testing-library/react@12.0.0---------- (package) │\n└───────────────────┴──────────────────────────────────────────────────────────┘\n")),(0,r.mdx)("h2",null,"Configuring Dev Files"),(0,r.mdx)("p",null,"Dev files are configured by setting glob patterns that match the files' names."),(0,r.mdx)("h3",null,"Setting Glob Patterns via ",(0,r.mdx)("inlineCode",{parentName:"h3"},"workspace.jsonc")),(0,r.mdx)("p",null,"Use the ",(0,r.mdx)("inlineCode",{parentName:"p"},"devFilePatterns")," property in ",(0,r.mdx)("inlineCode",{parentName:"p"},"teambit.component/dev-files")," to manually set a glob pattern for dev files."),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre",className:"language-json"},'{\n "teambit.workspace/variants": {\n "{ui/**}": {\n "teambit.component/dev-files": {\n "devFilePatterns": ["**/*.story.+(js|ts|jsx|tsx)"]\n }\n }\n }\n}\n')),(0,r.mdx)("h3",null,"Setting Glob Patterns via the Dev Files API"),(0,r.mdx)("p",null,"Update your extension or create an new one to register glob patterns for dev files, using the Dev Files ",(0,r.mdx)("inlineCode",{parentName:"p"},"registerDevPattern")," API."),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre"},"bit create aspect extensions/my-dev-files\n")),(0,r.mdx)("h4",null,"registerDevPattern"),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre",className:"language-ts"},"registerDevPattern: (pattern: string[]) : void\n")),(0,r.mdx)("p",null,"Use the ",(0,r.mdx)("inlineCode",{parentName:"p"},"registerDevPattern")," API to register an array of glob patterns."),(0,r.mdx)("p",null,"For example:"),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre",className:"language-ts"},"import { MainRuntime } from '@teambit/cli';\nimport { DevFilesAspect, DevFilesMain } from '@teambit/dev-files';\nimport { MyDevFilesAspect } from './my-dev-files.aspect';\n\nexport class MyDevFilesMain {\n constructor(private devFiles: DevFilesMain) {}\n\n static slots = [];\n\n static dependencies = [DevFilesAspect];\n\n static runtime = MainRuntime;\n\n static async provider([devFiles]: [DevFilesMain]) {\n devFiles.registerDevPattern(['**/*.my-dev.*']);\n\n return new MyDevFilesMain(devFiles);\n }\n}\n\nMyDevFilesAspect.addRuntime(MyDevFilesMain);\n")),(0,r.mdx)("p",null,"Configure the workspace config with that aspect to apply it on all components in the workspace:"),(0,r.mdx)("pre",null,(0,r.mdx)("code",{parentName:"pre",className:"language-json"},'// workspace.jsonc\n{\n "company.scope/extensions/my-dev-files": {}\n}\n'))))}u.__bit_component=o,u.isMDXComponent=!0},93805:function(e,t,n){var o=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0}),t.default=t.DevFiles=void 0;var r=n(50121);Object.defineProperty(t,"DevFiles",{enumerable:!0,get:function(){return o(r).default}}),Object.defineProperty(t,"default",{enumerable:!0,get:function(){return o(r).default}})},92139:(e,t,n)=>{var o={id:"teambit.component/dev-files@1.0.227",homepage:"https://bit.cloud/teambit/component/dev-files",exported:!0};function r(){const e=a(n(41594));return r=function(){return e},e}function a(e){return e&&e.__esModule?e:{default:e}}Object.defineProperty(t,"__esModule",{value:!0}),t.Logo=void 0,r.__bit_component=o,a.__bit_component=o;const i=()=>r().default.createElement("div",{style:{height:"100%",display:"flex",justifyContent:"center"}},r().default.createElement("img",{style:{width:70},src:"https://static.bit.dev/extensions-icons/dev-files.svg"}));i.__bit_component=o,t.Logo=i},5016:e=>{e.exports=MdxJsReact},41594:e=>{e.exports=React},65682:e=>{e.exports=TeambitMdxUiMdxScopeContext}},t={};function n(o){var r=t[o];if(void 0!==r)return r.exports;var a=t[o]={exports:{}};return e[o].call(a.exports,a,a.exports,n),a.exports}n.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return n.d(t,{a:t}),t},n.d=(e,t)=>{for(var o in t)n.o(t,o)&&!n.o(e,o)&&Object.defineProperty(e,o,{enumerable:!0,get:t[o]})},n.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),n.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var o={};return(()=>{n.r(o),n.d(o,{compositions:()=>u,compositions_metadata:()=>v,overview:()=>f});var e={};n.r(e),n.d(e,{default:()=>m});var t=n(92139),r=(n(41594),n(5016)),a=n(65682),i=n(93805),s=n.n(i),p=["components"];function d(){return d=Object.assign?Object.assign.bind():function(e){for(var t=1;t<arguments.length;t++){var n=arguments[t];for(var o in n)Object.prototype.hasOwnProperty.call(n,o)&&(e[o]=n[o])}return e},d.apply(this,arguments)}var l={},c="wrapper";function m(e){var t=e.components,n=function(e,t){if(null==e)return{};var n,o,r=function(e,t){if(null==e)return{};var n,o,r={},a=Object.keys(e);for(o=0;o<a.length;o++)n=a[o],t.indexOf(n)>=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o<a.length;o++)n=a[o],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}(e,p);return(0,r.mdx)(c,d({},l,n,{components:t,mdxType:"MDXLayout"}),(0,r.mdx)(a.MDXScopeProvider,{components:{DevFiles:s()},mdxType:"MDXScopeProvider"},(0,r.mdx)(s(),{mdxType:"DevFiles"})))}m.isMDXComponent=!0;const u=[t],f=[e],v={compositions:[{displayName:"Logo",identifier:"Logo"}]}})(),o})()));
@@ -74,11 +74,7 @@
74
74
  "line": 47,
75
75
  "character": 19
76
76
  },
77
- "name": "EnvsMain",
78
- "componentId": {
79
- "scope": "teambit.envs",
80
- "name": "envs"
81
- }
77
+ "name": "EnvsMain"
82
78
  },
83
79
  "isOptional": false,
84
80
  "isSpread": false
@@ -98,11 +94,7 @@
98
94
  "line": 49,
99
95
  "character": 24
100
96
  },
101
- "name": "Workspace",
102
- "componentId": {
103
- "scope": "teambit.workspace",
104
- "name": "workspace"
105
- }
97
+ "name": "Workspace"
106
98
  },
107
99
  "isOptional": false,
108
100
  "isSpread": false
@@ -122,8 +114,7 @@
122
114
  "line": 51,
123
115
  "character": 29
124
116
  },
125
- "name": "DevPatternSlot",
126
- "internalFilePath": "dev-files.main.runtime.ts"
117
+ "name": "DevPatternSlot"
127
118
  },
128
119
  "isOptional": false,
129
120
  "isSpread": false
@@ -143,8 +134,7 @@
143
134
  "line": 56,
144
135
  "character": 22
145
136
  },
146
- "name": "DevFilesConfig",
147
- "internalFilePath": "dev-files.main.runtime.ts"
137
+ "name": "DevFilesConfig"
148
138
  },
149
139
  "isOptional": false,
150
140
  "isSpread": false
@@ -196,11 +186,7 @@
196
186
  "line": 64,
197
187
  "character": 39
198
188
  },
199
- "name": "Component",
200
- "componentId": {
201
- "scope": "teambit.component",
202
- "name": "component"
203
- }
189
+ "name": "Component"
204
190
  },
205
191
  "isOptional": false,
206
192
  "isSpread": false
@@ -254,11 +240,7 @@
254
240
  "line": 161,
255
241
  "character": 29
256
242
  },
257
- "name": "Component",
258
- "componentId": {
259
- "scope": "teambit.component",
260
- "name": "component"
261
- }
243
+ "name": "Component"
262
244
  },
263
245
  "isOptional": false,
264
246
  "isSpread": false
@@ -338,11 +320,7 @@
338
320
  "line": 170,
339
321
  "character": 24
340
322
  },
341
- "name": "Component",
342
- "componentId": {
343
- "scope": "teambit.component",
344
- "name": "component"
345
- }
323
+ "name": "Component"
346
324
  },
347
325
  "isOptional": false,
348
326
  "isSpread": false
@@ -427,8 +405,7 @@
427
405
  "line": 179,
428
406
  "character": 31
429
407
  },
430
- "name": "DevPatterns",
431
- "internalFilePath": "dev-files.main.runtime.ts"
408
+ "name": "DevPatterns"
432
409
  },
433
410
  "isOptional": false,
434
411
  "isSpread": false
@@ -480,11 +457,7 @@
480
457
  "line": 187,
481
458
  "character": 26
482
459
  },
483
- "name": "Component",
484
- "componentId": {
485
- "scope": "teambit.component",
486
- "name": "component"
487
- }
460
+ "name": "Component"
488
461
  },
489
462
  "isOptional": false,
490
463
  "isSpread": false
@@ -527,8 +500,7 @@
527
500
  "line": 193,
528
501
  "character": 55
529
502
  },
530
- "name": "LegacyComponent",
531
- "packageName": "@teambit/legacy/dist/consumer/component"
503
+ "name": "LegacyComponent"
532
504
  },
533
505
  "isOptional": false,
534
506
  "isSpread": false
@@ -601,11 +573,7 @@
601
573
  "line": 205,
602
574
  "character": 36
603
575
  },
604
- "name": "Component",
605
- "componentId": {
606
- "scope": "teambit.component",
607
- "name": "component"
608
- }
576
+ "name": "Component"
609
577
  },
610
578
  "isOptional": false,
611
579
  "isSpread": false
@@ -627,8 +595,7 @@
627
595
  "line": 205,
628
596
  "character": 56
629
597
  },
630
- "name": "DevFiles",
631
- "internalFilePath": "dev-files.ts"
598
+ "name": "DevFiles"
632
599
  }
633
600
  ]
634
601
  },
@@ -753,11 +720,7 @@
753
720
  "line": 228,
754
721
  "character": 58
755
722
  },
756
- "name": "EnvsMain",
757
- "componentId": {
758
- "scope": "teambit.envs",
759
- "name": "envs"
760
- }
723
+ "name": "EnvsMain"
761
724
  },
762
725
  {
763
726
  "__schema": "TypeRefSchema",
@@ -766,11 +729,7 @@
766
729
  "line": 228,
767
730
  "character": 68
768
731
  },
769
- "name": "Workspace",
770
- "componentId": {
771
- "scope": "teambit.workspace",
772
- "name": "workspace"
773
- }
732
+ "name": "Workspace"
774
733
  },
775
734
  {
776
735
  "__schema": "TypeRefSchema",
@@ -779,11 +738,7 @@
779
738
  "line": 228,
780
739
  "character": 79
781
740
  },
782
- "name": "ComponentMain",
783
- "componentId": {
784
- "scope": "teambit.component",
785
- "name": "component"
786
- }
741
+ "name": "ComponentMain"
787
742
  },
788
743
  {
789
744
  "__schema": "TypeRefSchema",
@@ -792,11 +747,7 @@
792
747
  "line": 228,
793
748
  "character": 94
794
749
  },
795
- "name": "GraphqlMain",
796
- "componentId": {
797
- "scope": "teambit.harmony",
798
- "name": "graphql"
799
- }
750
+ "name": "GraphqlMain"
800
751
  },
801
752
  {
802
753
  "__schema": "TypeRefSchema",
@@ -805,11 +756,7 @@
805
756
  "line": 228,
806
757
  "character": 107
807
758
  },
808
- "name": "ScopeMain",
809
- "componentId": {
810
- "scope": "teambit.scope",
811
- "name": "scope"
812
- }
759
+ "name": "ScopeMain"
813
760
  }
814
761
  ]
815
762
  },
@@ -831,8 +778,7 @@
831
778
  "line": 229,
832
779
  "character": 13
833
780
  },
834
- "name": "DevFilesConfig",
835
- "internalFilePath": "dev-files.main.runtime.ts"
781
+ "name": "DevFilesConfig"
836
782
  },
837
783
  "isOptional": false,
838
784
  "isSpread": false
@@ -860,8 +806,7 @@
860
806
  "line": 230,
861
807
  "character": 24
862
808
  },
863
- "name": "DevPatternSlot",
864
- "internalFilePath": "dev-files.main.runtime.ts"
809
+ "name": "DevPatternSlot"
865
810
  }
866
811
  ]
867
812
  },
@@ -987,7 +932,7 @@
987
932
  "line": 34,
988
933
  "character": 28
989
934
  },
990
- "signature": "(component: \u001b[2m(component: teambit.component/component)\u001b[22m Component): DevPattern",
935
+ "signature": "(component: Component): DevPattern",
991
936
  "name": "",
992
937
  "params": [
993
938
  {
@@ -1005,11 +950,7 @@
1005
950
  "line": 34,
1006
951
  "character": 40
1007
952
  },
1008
- "name": "Component",
1009
- "componentId": {
1010
- "scope": "teambit.component",
1011
- "name": "component"
1012
- }
953
+ "name": "Component"
1013
954
  },
1014
955
  "isOptional": false,
1015
956
  "isSpread": false
@@ -1022,8 +963,7 @@
1022
963
  "line": 34,
1023
964
  "character": 54
1024
965
  },
1025
- "name": "DevPattern",
1026
- "internalFilePath": "dev-files.main.runtime.ts"
966
+ "name": "DevPattern"
1027
967
  },
1028
968
  "modifiers": []
1029
969
  }
@@ -1035,8 +975,7 @@
1035
975
  "line": 34,
1036
976
  "character": 68
1037
977
  },
1038
- "name": "DevPattern",
1039
- "internalFilePath": "dev-files.main.runtime.ts"
978
+ "name": "DevPattern"
1040
979
  }
1041
980
  ]
1042
981
  }
@@ -1068,11 +1007,6 @@
1068
1007
  "character": 30
1069
1008
  },
1070
1009
  "name": "SlotRegistry",
1071
- "componentId": {
1072
- "scope": "teambit.harmony",
1073
- "name": "harmony",
1074
- "version": "0.4.6"
1075
- },
1076
1010
  "typeArgs": [
1077
1011
  {
1078
1012
  "__schema": "TypeRefSchema",
@@ -1081,8 +1015,7 @@
1081
1015
  "line": 39,
1082
1016
  "character": 43
1083
1017
  },
1084
- "name": "DevPatterns",
1085
- "internalFilePath": "dev-files.main.runtime.ts"
1018
+ "name": "DevPatterns"
1086
1019
  }
1087
1020
  ]
1088
1021
  }
@@ -1170,11 +1103,7 @@
1170
1103
  "line": 47,
1171
1104
  "character": 19
1172
1105
  },
1173
- "name": "EnvsMain",
1174
- "componentId": {
1175
- "scope": "teambit.envs",
1176
- "name": "envs"
1177
- }
1106
+ "name": "EnvsMain"
1178
1107
  },
1179
1108
  "isOptional": false,
1180
1109
  "isSpread": false
@@ -1194,11 +1123,7 @@
1194
1123
  "line": 49,
1195
1124
  "character": 24
1196
1125
  },
1197
- "name": "Workspace",
1198
- "componentId": {
1199
- "scope": "teambit.workspace",
1200
- "name": "workspace"
1201
- }
1126
+ "name": "Workspace"
1202
1127
  },
1203
1128
  "isOptional": false,
1204
1129
  "isSpread": false
@@ -1218,8 +1143,7 @@
1218
1143
  "line": 51,
1219
1144
  "character": 29
1220
1145
  },
1221
- "name": "DevPatternSlot",
1222
- "internalFilePath": "dev-files.main.runtime.ts"
1146
+ "name": "DevPatternSlot"
1223
1147
  },
1224
1148
  "isOptional": false,
1225
1149
  "isSpread": false
@@ -1239,8 +1163,7 @@
1239
1163
  "line": 56,
1240
1164
  "character": 22
1241
1165
  },
1242
- "name": "DevFilesConfig",
1243
- "internalFilePath": "dev-files.main.runtime.ts"
1166
+ "name": "DevFilesConfig"
1244
1167
  },
1245
1168
  "isOptional": false,
1246
1169
  "isSpread": false
@@ -1292,11 +1215,7 @@
1292
1215
  "line": 64,
1293
1216
  "character": 39
1294
1217
  },
1295
- "name": "Component",
1296
- "componentId": {
1297
- "scope": "teambit.component",
1298
- "name": "component"
1299
- }
1218
+ "name": "Component"
1300
1219
  },
1301
1220
  "isOptional": false,
1302
1221
  "isSpread": false
@@ -1350,11 +1269,7 @@
1350
1269
  "line": 161,
1351
1270
  "character": 29
1352
1271
  },
1353
- "name": "Component",
1354
- "componentId": {
1355
- "scope": "teambit.component",
1356
- "name": "component"
1357
- }
1272
+ "name": "Component"
1358
1273
  },
1359
1274
  "isOptional": false,
1360
1275
  "isSpread": false
@@ -1434,11 +1349,7 @@
1434
1349
  "line": 170,
1435
1350
  "character": 24
1436
1351
  },
1437
- "name": "Component",
1438
- "componentId": {
1439
- "scope": "teambit.component",
1440
- "name": "component"
1441
- }
1352
+ "name": "Component"
1442
1353
  },
1443
1354
  "isOptional": false,
1444
1355
  "isSpread": false
@@ -1523,8 +1434,7 @@
1523
1434
  "line": 179,
1524
1435
  "character": 31
1525
1436
  },
1526
- "name": "DevPatterns",
1527
- "internalFilePath": "dev-files.main.runtime.ts"
1437
+ "name": "DevPatterns"
1528
1438
  },
1529
1439
  "isOptional": false,
1530
1440
  "isSpread": false
@@ -1576,11 +1486,7 @@
1576
1486
  "line": 187,
1577
1487
  "character": 26
1578
1488
  },
1579
- "name": "Component",
1580
- "componentId": {
1581
- "scope": "teambit.component",
1582
- "name": "component"
1583
- }
1489
+ "name": "Component"
1584
1490
  },
1585
1491
  "isOptional": false,
1586
1492
  "isSpread": false
@@ -1623,8 +1529,7 @@
1623
1529
  "line": 193,
1624
1530
  "character": 55
1625
1531
  },
1626
- "name": "LegacyComponent",
1627
- "packageName": "@teambit/legacy/dist/consumer/component"
1532
+ "name": "LegacyComponent"
1628
1533
  },
1629
1534
  "isOptional": false,
1630
1535
  "isSpread": false
@@ -1697,11 +1602,7 @@
1697
1602
  "line": 205,
1698
1603
  "character": 36
1699
1604
  },
1700
- "name": "Component",
1701
- "componentId": {
1702
- "scope": "teambit.component",
1703
- "name": "component"
1704
- }
1605
+ "name": "Component"
1705
1606
  },
1706
1607
  "isOptional": false,
1707
1608
  "isSpread": false
@@ -1723,8 +1624,7 @@
1723
1624
  "line": 205,
1724
1625
  "character": 56
1725
1626
  },
1726
- "name": "DevFiles",
1727
- "internalFilePath": "dev-files.ts"
1627
+ "name": "DevFiles"
1728
1628
  }
1729
1629
  ]
1730
1630
  },
@@ -1849,11 +1749,7 @@
1849
1749
  "line": 228,
1850
1750
  "character": 58
1851
1751
  },
1852
- "name": "EnvsMain",
1853
- "componentId": {
1854
- "scope": "teambit.envs",
1855
- "name": "envs"
1856
- }
1752
+ "name": "EnvsMain"
1857
1753
  },
1858
1754
  {
1859
1755
  "__schema": "TypeRefSchema",
@@ -1862,11 +1758,7 @@
1862
1758
  "line": 228,
1863
1759
  "character": 68
1864
1760
  },
1865
- "name": "Workspace",
1866
- "componentId": {
1867
- "scope": "teambit.workspace",
1868
- "name": "workspace"
1869
- }
1761
+ "name": "Workspace"
1870
1762
  },
1871
1763
  {
1872
1764
  "__schema": "TypeRefSchema",
@@ -1875,11 +1767,7 @@
1875
1767
  "line": 228,
1876
1768
  "character": 79
1877
1769
  },
1878
- "name": "ComponentMain",
1879
- "componentId": {
1880
- "scope": "teambit.component",
1881
- "name": "component"
1882
- }
1770
+ "name": "ComponentMain"
1883
1771
  },
1884
1772
  {
1885
1773
  "__schema": "TypeRefSchema",
@@ -1888,11 +1776,7 @@
1888
1776
  "line": 228,
1889
1777
  "character": 94
1890
1778
  },
1891
- "name": "GraphqlMain",
1892
- "componentId": {
1893
- "scope": "teambit.harmony",
1894
- "name": "graphql"
1895
- }
1779
+ "name": "GraphqlMain"
1896
1780
  },
1897
1781
  {
1898
1782
  "__schema": "TypeRefSchema",
@@ -1901,11 +1785,7 @@
1901
1785
  "line": 228,
1902
1786
  "character": 107
1903
1787
  },
1904
- "name": "ScopeMain",
1905
- "componentId": {
1906
- "scope": "teambit.scope",
1907
- "name": "scope"
1908
- }
1788
+ "name": "ScopeMain"
1909
1789
  }
1910
1790
  ]
1911
1791
  },
@@ -1927,8 +1807,7 @@
1927
1807
  "line": 229,
1928
1808
  "character": 13
1929
1809
  },
1930
- "name": "DevFilesConfig",
1931
- "internalFilePath": "dev-files.main.runtime.ts"
1810
+ "name": "DevFilesConfig"
1932
1811
  },
1933
1812
  "isOptional": false,
1934
1813
  "isSpread": false
@@ -1956,8 +1835,7 @@
1956
1835
  "line": 230,
1957
1836
  "character": 24
1958
1837
  },
1959
- "name": "DevPatternSlot",
1960
- "internalFilePath": "dev-files.main.runtime.ts"
1838
+ "name": "DevPatternSlot"
1961
1839
  }
1962
1840
  ]
1963
1841
  },
@@ -2114,8 +1992,7 @@
2114
1992
  "line": 29,
2115
1993
  "character": 30
2116
1994
  },
2117
- "name": "DevPatternDescriptor",
2118
- "internalFilePath": "dev-files.main.runtime.ts"
1995
+ "name": "DevPatternDescriptor"
2119
1996
  }
2120
1997
  ]
2121
1998
  }
@@ -2136,7 +2013,7 @@
2136
2013
  "componentId": {
2137
2014
  "scope": "teambit.component",
2138
2015
  "name": "dev-files",
2139
- "version": "1.0.225"
2016
+ "version": "1.0.227"
2140
2017
  },
2141
2018
  "taggedModuleExports": []
2142
2019
  }
@@ -1,5 +1,5 @@
1
- import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_dev-files@1.0.225/dist/dev-files.composition.js';
2
- import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_dev-files@1.0.225/dist/dev-files.docs.mdx';
1
+ import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_dev-files@1.0.227/dist/dev-files.composition.js';
2
+ import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_dev-files@1.0.227/dist/dev-files.docs.mdx';
3
3
 
4
4
  export const compositions = [compositions_0];
5
5
  export const overview = [overview_0];
package/package.json CHANGED
@@ -1,24 +1,24 @@
1
1
  {
2
2
  "name": "@teambit/dev-files",
3
- "version": "1.0.225",
3
+ "version": "1.0.227",
4
4
  "homepage": "https://bit.cloud/teambit/component/dev-files",
5
5
  "main": "dist/index.js",
6
6
  "componentId": {
7
7
  "scope": "teambit.component",
8
8
  "name": "dev-files",
9
- "version": "1.0.225"
9
+ "version": "1.0.227"
10
10
  },
11
11
  "dependencies": {
12
12
  "graphql-tag": "2.12.1",
13
13
  "comment-json": "3.0.3",
14
14
  "lodash": "4.17.21",
15
15
  "@teambit/harmony": "0.4.6",
16
- "@teambit/component": "1.0.225",
17
- "@teambit/graphql": "1.0.225",
18
- "@teambit/cli": "0.0.859",
19
- "@teambit/envs": "1.0.225",
20
- "@teambit/scope": "1.0.225",
21
- "@teambit/workspace": "1.0.225"
16
+ "@teambit/component": "1.0.227",
17
+ "@teambit/graphql": "1.0.227",
18
+ "@teambit/cli": "0.0.860",
19
+ "@teambit/envs": "1.0.227",
20
+ "@teambit/scope": "1.0.227",
21
+ "@teambit/workspace": "1.0.227"
22
22
  },
23
23
  "devDependencies": {
24
24
  "@types/lodash": "4.14.165",
@@ -26,7 +26,7 @@
26
26
  "chai": "4.3.0",
27
27
  "@types/mocha": "9.1.0",
28
28
  "@teambit/component.content.dev-files": "1.95.9",
29
- "@teambit/harmony.envs.core-aspect-env": "0.0.27"
29
+ "@teambit/harmony.envs.core-aspect-env": "0.0.30"
30
30
  },
31
31
  "peerDependencies": {
32
32
  "react": "^17.0.0 || ^18.0.0",
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,25 @@
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.227"
43
+ },
44
+ {
45
+ "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_graphql@1.0.227"
46
+ },
47
+ {
48
+ "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_cli@0.0.860"
49
+ },
50
+ {
51
+ "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.envs_envs@1.0.227"
52
+ },
53
+ {
54
+ "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.scope_scope@1.0.227"
55
+ },
56
+ {
57
+ "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.workspace_workspace@1.0.227"
58
+ }
38
59
  ]
39
60
  }
@@ -1,2 +0,0 @@
1
- import { Aspect } from '@teambit/harmony';
2
- export declare const DevFilesAspect: Aspect;
@@ -1 +0,0 @@
1
- export declare const Logo: () => import("react/jsx-runtime").JSX.Element;
@@ -1,30 +0,0 @@
1
- export declare class DevFiles {
2
- private raw;
3
- constructor(raw: {
4
- [key: string]: string[];
5
- });
6
- /**
7
- * get all dev files of an aspect (for example: teambit.defender/tester)
8
- */
9
- get(aspectId: string): string[];
10
- toTupleArray(): string[][];
11
- /**
12
- * list all dev files.
13
- */
14
- list(): string[];
15
- /**
16
- * determine whether a file is included in the dev files.
17
- * @param filePath
18
- */
19
- includes(filePath: string): boolean;
20
- /**
21
- * return a plain object with all dev files.
22
- */
23
- toObject(): {
24
- [key: string]: string[];
25
- };
26
- /**
27
- * serialize all dev files into a JSON string.
28
- */
29
- toString(pretty?: boolean): string;
30
- }
@@ -1,19 +0,0 @@
1
- import { ShowFragment, Component } from '@teambit/component';
2
- import { DevFilesMain } from './dev-files.main.runtime';
3
- export declare class DevFilesFragment implements ShowFragment {
4
- private devFiles;
5
- constructor(devFiles: DevFilesMain);
6
- title: string;
7
- stringifyDevFiles(component: Component): string;
8
- renderRow(component: Component): Promise<{
9
- title: string;
10
- content: string;
11
- }>;
12
- json(component: Component): Promise<{
13
- title: string;
14
- json: {
15
- [key: string]: string[];
16
- };
17
- }>;
18
- weight: number;
19
- }
@@ -1,3 +0,0 @@
1
- import { Schema } from '@teambit/graphql';
2
- import { DevFilesMain } from './dev-files.main.runtime';
3
- export declare function devFilesSchema(devFilesMain: DevFilesMain): Schema;
@@ -1,90 +0,0 @@
1
- import { ScopeMain } from '@teambit/scope';
2
- import { SlotRegistry } from '@teambit/harmony';
3
- import { Workspace } from '@teambit/workspace';
4
- import { EnvsMain } from '@teambit/envs';
5
- import LegacyComponent from '@teambit/legacy/dist/consumer/component';
6
- import { Component, ComponentMain } from '@teambit/component';
7
- import { GraphqlMain } from '@teambit/graphql';
8
- import { DevFiles } from './dev-files';
9
- type DevPatternDescriptor = {
10
- /**
11
- * Name of the dev pattern
12
- */
13
- name: string;
14
- /**
15
- * Glob pattern to select dev files
16
- */
17
- pattern: string[];
18
- };
19
- type DevPattern = string[] | DevPatternDescriptor;
20
- /**
21
- * dev pattern is a list of strings or a function that returns a list of strings. an example to a pattern can be "[*.spec.ts]"
22
- */
23
- export type DevPatterns = ((component: Component) => DevPattern) | DevPattern;
24
- /**
25
- * slot for dev file patterns.
26
- */
27
- export type DevPatternSlot = SlotRegistry<DevPatterns>;
28
- export type DevFilesConfig = {
29
- patterns: string[];
30
- };
31
- export declare class DevFilesMain {
32
- private envs;
33
- private workspace;
34
- private devPatternSlot;
35
- /**
36
- * configuration loaded into the dev files aspect.
37
- */
38
- readonly config: DevFilesConfig;
39
- constructor(envs: EnvsMain, workspace: Workspace, devPatternSlot: DevPatternSlot,
40
- /**
41
- * configuration loaded into the dev files aspect.
42
- */
43
- config: DevFilesConfig);
44
- /**
45
- * compute all dev patterns on a component.
46
- * computing of dev patterns is a merge of the configuration, the env (env.getDevPatterns(component)) and
47
- * the registering aspects (through registerDevPattern()).
48
- */
49
- computeDevPatterns(component: Component): Promise<{
50
- config: any;
51
- } & {
52
- [id: string]: string[];
53
- } & {
54
- [id: string]: string[];
55
- }>;
56
- private computeDevPatternsFromSlot;
57
- private computeDevPatternsFromEnv;
58
- private computeDevPatternsFromEnvJsoncFile;
59
- /**
60
- * get all dev files configured on a component.
61
- */
62
- getDevPatterns(component: Component, aspectId?: string): string[];
63
- /**
64
- * determine whether a file of a component is a dev file.
65
- */
66
- isDevFile(component: Component, filePath: string): boolean;
67
- /**
68
- * register a new dev pattern.
69
- * @param regex dev pattern
70
- */
71
- registerDevPattern(pattern: DevPatterns): void;
72
- /**
73
- * get all dev patterns registered.
74
- * If you want to use this during onLoad event you might need to use computeDevFiles instead, since the component might not include this data yet
75
- */
76
- getDevFiles(component: Component): DevFiles;
77
- getDevFilesForConsumerComp(consumerComponent: LegacyComponent): Promise<string[]>;
78
- /**
79
- * compute all dev files of a component.
80
- */
81
- computeDevFiles(component: Component): Promise<DevFiles>;
82
- static slots: ((registerFn: () => string) => SlotRegistry<DevPatterns>)[];
83
- static defaultConfig: {
84
- patterns: never[];
85
- };
86
- static runtime: import("@teambit/harmony").RuntimeDefinition;
87
- static dependencies: import("@teambit/harmony").Aspect[];
88
- static provider([envs, workspace, componentAspect, graphql, scope]: [EnvsMain, Workspace, ComponentMain, GraphqlMain, ScopeMain], config: DevFilesConfig, [devPatternSlot]: [DevPatternSlot]): Promise<DevFilesMain>;
89
- }
90
- export {};
@@ -1 +0,0 @@
1
- export {};
package/dist/index.d.ts DELETED
@@ -1,4 +0,0 @@
1
- import { DevFilesAspect } from './dev-files.aspect';
2
- export { DevFilesAspect };
3
- export type { DevFilesMain } from './dev-files.main.runtime';
4
- export default DevFilesAspect;