@elliemae/pui-cli 9.0.0-alpha.12 → 9.0.0-alpha.13
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/README.md +4 -3
- package/build/docs/404.html +4 -4
- package/build/docs/api/functions/loadRoutes/index.html +9 -9
- package/build/docs/api/index.html +8 -8
- package/build/docs/api/type-aliases/LIB_NAME/index.html +5 -5
- package/build/docs/api/variables/babelConfig/index.html +5 -28
- package/build/docs/api/variables/commitlintConfig/index.html +5 -8
- package/build/docs/api/variables/eslintFlatBaseConfig/index.html +6 -6
- package/build/docs/api/variables/eslintFlatBaseConfigStrict/index.html +6 -6
- package/build/docs/api/variables/eslintFlatConfig/index.html +6 -6
- package/build/docs/api/variables/eslintFlatConfigStrict/index.html +6 -6
- package/build/docs/api/variables/jestConfig/index.html +86 -86
- package/build/docs/api/variables/jestNodeConfig/index.html +86 -86
- package/build/docs/api/variables/lintStagedConfig/index.html +22 -12
- package/build/docs/api/variables/prettierConfig/index.html +5 -18
- package/build/docs/api/variables/stylelintConfig/index.html +5 -5
- package/build/docs/api/variables/vitestConfig/index.html +5 -5
- package/build/docs/assets/css/{styles.74603f39.css → styles.3cba4e67.css} +1 -1
- package/build/docs/assets/js/04ee7372.c6c3d513.js +1 -0
- package/build/docs/assets/js/0551d4dd.a6b1d9fa.js +1 -0
- package/build/docs/assets/js/0a1d0315.43980061.js +1 -0
- package/build/docs/assets/js/13097d8d.4ac8ef79.js +1 -0
- package/build/docs/assets/js/{16b7bc88.c3779e27.js → 16b7bc88.2ac57556.js} +1 -1
- package/build/docs/assets/js/{17896441.84339068.js → 17896441.705d85a0.js} +1 -1
- package/build/docs/assets/js/{1b9df811.aaa95da1.js → 1b9df811.ec75cfdc.js} +1 -1
- package/build/docs/assets/js/{232a0286.33b2782b.js → 232a0286.6f749ae5.js} +1 -1
- package/build/docs/assets/js/{2399.cc5803e0.js → 2399.5d123cba.js} +1 -1
- package/build/docs/assets/js/{37d86055.47211796.js → 37d86055.1e73f036.js} +1 -1
- package/build/docs/assets/js/3992.b9b54f94.js +2 -0
- package/build/docs/assets/js/{4fb6949f.69e375e4.js → 4fb6949f.13bde4a8.js} +1 -1
- package/build/docs/assets/js/5befad71.96f04f67.js +1 -0
- package/build/docs/assets/js/5d5f1db0.e7607cd2.js +1 -0
- package/build/docs/assets/js/5e8c322a.0b86bf5a.js +1 -0
- package/build/docs/assets/js/5e95c892.de377e27.js +1 -0
- package/build/docs/assets/js/{5fb3c522.da5628e8.js → 5fb3c522.3ec831ee.js} +1 -1
- package/build/docs/assets/js/6bd11e52.c61bfcd5.js +1 -0
- package/build/docs/assets/js/6e96545e.1b545333.js +1 -0
- package/build/docs/assets/js/{71f6d02b.cfd98385.js → 71f6d02b.4b381360.js} +1 -1
- package/build/docs/assets/js/{6704.2615a5c6.js → 7843.f4b19776.js} +1 -1
- package/build/docs/assets/js/80e87108.8c451f49.js +1 -0
- package/build/docs/assets/js/{8585.3cb09ff7.js → 8585.e2298db3.js} +1 -1
- package/build/docs/assets/js/{a7bd4aaa.30ffad02.js → a7bd4aaa.aceac89c.js} +1 -1
- package/build/docs/assets/js/a94703ab.248144c2.js +1 -0
- package/build/docs/assets/js/b7b585d8.7d50f3f6.js +1 -0
- package/build/docs/assets/js/{bde5209a.f5bca8b2.js → bde5209a.480cc8d8.js} +1 -1
- package/build/docs/assets/js/c377a04b.c6b6b394.js +1 -0
- package/build/docs/assets/js/{dfd75424.51c4e2cb.js → dfd75424.459da76b.js} +1 -1
- package/build/docs/assets/js/f736c962.ab424879.js +1 -0
- package/build/docs/assets/js/main.3ae939d4.js +2 -0
- package/build/docs/assets/js/runtime~main.9ecf1839.js +1 -0
- package/build/docs/eslint-rules-migration/index.html +39 -39
- package/build/docs/index.html +70 -71
- package/build/docs/pui-cli-9-migration/index.html +163 -99
- package/build/docs/sitemap.xml +1 -1
- package/build/docs/ssl-certificate-setup/index.html +23 -23
- package/build/docs/stylelint-migration/index.html +19 -21
- package/build/docs/usage-guide/index.html +90 -90
- package/dist/cjs/babel.config.js +124 -0
- package/dist/cjs/index.js +5 -9
- package/dist/cjs/lint-config/commitlint/export.mjs +1 -0
- package/dist/cjs/lint-config/commitlint.config.mjs +6 -0
- package/dist/cjs/lint-config/eslint/common.cjs +8 -1
- package/dist/cjs/lint-config/eslint/flat/rules.mjs +1 -0
- package/dist/cjs/lint-config/lint-staged.config.js +17 -5
- package/dist/cjs/lint-config/prettier/export.mjs +1 -0
- package/dist/cjs/lint-config/{prettier.config.cjs → prettier.config.mjs} +4 -1
- package/dist/cjs/skills/migrate-storybook-out-of-cjs/SKILL.md +89 -35
- package/dist/cjs/skills/migrate-to-pui-cli-9/SKILL.md +126 -38
- package/dist/cjs/testing/{jest.config.cjs → jest.config.mjs} +9 -5
- package/dist/{esm/testing/jest.node.config.cjs → cjs/testing/jest.node.config.mjs} +3 -2
- package/dist/esm/babel.config.js +94 -0
- package/dist/esm/index.js +5 -9
- package/dist/esm/lint-config/commitlint/export.mjs +1 -0
- package/dist/esm/lint-config/commitlint.config.mjs +6 -0
- package/dist/esm/lint-config/eslint/common.cjs +8 -1
- package/dist/esm/lint-config/eslint/flat/rules.mjs +1 -0
- package/dist/esm/lint-config/lint-staged.config.js +17 -5
- package/dist/esm/lint-config/prettier/export.mjs +1 -0
- package/{lib/lint-config/prettier.config.cjs → dist/esm/lint-config/prettier.config.mjs} +4 -1
- package/dist/esm/skills/migrate-storybook-out-of-cjs/SKILL.md +89 -35
- package/dist/esm/skills/migrate-to-pui-cli-9/SKILL.md +126 -38
- package/dist/esm/testing/{jest.config.cjs → jest.config.mjs} +9 -5
- package/dist/{cjs/testing/jest.node.config.cjs → esm/testing/jest.node.config.mjs} +3 -2
- package/dist/types/lib/babel.config.d.ts +3 -0
- package/dist/types/lib/index.d.ts +5 -9
- package/dist/types/lib/lint-config/commitlint/export.d.mts +1 -0
- package/dist/types/lib/lint-config/commitlint.config.d.mts +3 -0
- package/dist/types/lib/lint-config/eslint/common.d.cts +8 -2
- package/dist/types/lib/lint-config/eslint/non-react.d.cts +8 -1
- package/dist/types/lib/lint-config/eslint/react.d.cts +8 -1
- package/dist/types/lib/lint-config/eslint/typescript/non-react.d.cts +8 -1
- package/dist/types/lib/lint-config/eslint/typescript/react.d.cts +8 -1
- package/dist/types/lib/lint-config/lint-staged.config.d.ts +2 -2
- package/dist/types/lib/lint-config/prettier/export.d.mts +1 -0
- package/dist/types/lib/lint-config/prettier.config.d.mts +3 -0
- package/dist/types/lib/utils.d.cts +1 -1
- package/dist/types/lib/utils.d.ts +1 -1
- package/dist/types/tsconfig.tsbuildinfo +1 -1
- package/lib/lint-config/commitlint/export.mjs +1 -0
- package/lib/lint-config/commitlint.config.mjs +6 -0
- package/lib/lint-config/eslint/common.cjs +8 -1
- package/lib/lint-config/eslint/flat/rules.mjs +1 -0
- package/lib/lint-config/lint-staged.config.js +20 -5
- package/lib/lint-config/prettier/export.mjs +1 -0
- package/{dist/esm/lint-config/prettier.config.cjs → lib/lint-config/prettier.config.mjs} +4 -1
- package/lib/skills/migrate-storybook-out-of-cjs/SKILL.md +89 -35
- package/lib/skills/migrate-to-pui-cli-9/SKILL.md +126 -38
- package/lib/testing/jest.config.mjs +124 -0
- package/lib/testing/jest.node.config.mjs +9 -0
- package/package.json +38 -22
- package/build/docs/api/variables/eslintBaseConfig/index.html +0 -132
- package/build/docs/api/variables/eslintConfig/index.html +0 -180
- package/build/docs/assets/js/04ee7372.2852111b.js +0 -1
- package/build/docs/assets/js/0551d4dd.ebb18f4f.js +0 -1
- package/build/docs/assets/js/0a1d0315.fc8f91a7.js +0 -1
- package/build/docs/assets/js/13097d8d.7877421c.js +0 -1
- package/build/docs/assets/js/3992.0ac29b2f.js +0 -2
- package/build/docs/assets/js/5befad71.5f19afb5.js +0 -1
- package/build/docs/assets/js/5d5f1db0.c5aa5afa.js +0 -1
- package/build/docs/assets/js/5e8c322a.ef3b894b.js +0 -1
- package/build/docs/assets/js/5e95c892.f550b901.js +0 -1
- package/build/docs/assets/js/6bd11e52.08b95209.js +0 -1
- package/build/docs/assets/js/6e96545e.30c1b801.js +0 -1
- package/build/docs/assets/js/80e87108.f9507b95.js +0 -1
- package/build/docs/assets/js/a94703ab.f1796514.js +0 -1
- package/build/docs/assets/js/b7b585d8.6d53e73f.js +0 -1
- package/build/docs/assets/js/b8ac1d98.62684003.js +0 -1
- package/build/docs/assets/js/c377a04b.0f8625c6.js +0 -1
- package/build/docs/assets/js/e5f79924.c793a74d.js +0 -1
- package/build/docs/assets/js/f736c962.dbd0d004.js +0 -1
- package/build/docs/assets/js/main.d5acb4ca.js +0 -2
- package/build/docs/assets/js/runtime~main.4f7cd700.js +0 -1
- package/dist/cjs/babel.config.cjs +0 -97
- package/dist/cjs/index.cjs +0 -35
- package/dist/cjs/lint-config/commitlint.config.cjs +0 -1
- package/dist/cjs/lint-config/stylelint.config.cjs +0 -3
- package/dist/esm/babel.config.cjs +0 -97
- package/dist/esm/index.cjs +0 -35
- package/dist/esm/lint-config/commitlint.config.cjs +0 -1
- package/dist/esm/lint-config/stylelint.config.cjs +0 -3
- package/dist/types/lib/babel.config.d.cts +0 -59
- package/dist/types/lib/index.d.cts +0 -13
- package/dist/types/lib/lint-config/commitlint.config.d.cts +0 -4
- package/dist/types/lib/lint-config/prettier.config.d.cts +0 -8
- package/dist/types/lib/lint-config/stylelint.config.d.cts +0 -2
- package/lib/lint-config/commitlint.config.cjs +0 -1
- package/lib/lint-config/stylelint.config.cjs +0 -3
- /package/build/docs/assets/js/{3992.0ac29b2f.js.LICENSE.txt → 3992.b9b54f94.js.LICENSE.txt} +0 -0
- /package/build/docs/assets/js/{main.d5acb4ca.js.LICENSE.txt → main.3ae939d4.js.LICENSE.txt} +0 -0
- /package/dist/types/lib/testing/{jest.config.d.cts → jest.config.d.mts} +0 -0
- /package/dist/types/lib/testing/{jest.node.config.d.cts → jest.node.config.d.mts} +0 -0
|
@@ -1 +0,0 @@
|
|
|
1
|
-
"use strict";(globalThis.webpackChunk_elliemae_pui_cli=globalThis.webpackChunk_elliemae_pui_cli||[]).push([[1380],{7432(e,n,i){i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>a,frontMatter:()=>d,metadata:()=>l,toc:()=>o});const l=JSON.parse('{"id":"stylelint-migration","title":"Stylelint migration guide (pui-cli 8 \u2192 9 / Stylelint 17)","description":"This document covers Stylelint changes shipped with pui-cli 9 (Stylelint 17.x).","source":"@site/docs/stylelint-migration.md","sourceDirName":".","slug":"/stylelint-migration","permalink":"/cli/stylelint-migration","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-cli.git/docs/stylelint-migration.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"Trust SSL Certificate Guide","permalink":"/cli/ssl-certificate-setup"},"next":{"title":"Usage Guide","permalink":"/cli/usage-guide"}}');var s=i(6070),t=i(6607);const d={},r="Stylelint migration guide (pui-cli 8 \u2192 9 / Stylelint 17)",c={},o=[{value:"At a glance",id:"at-a-glance",level:2},{value:"Why <code>stylelint-config-styled-components</code> was removed",id:"why-stylelint-config-styled-components-was-removed",level:2},{value:"How to upgrade a repo",id:"how-to-upgrade-a-repo",level:2},{value:"ESM config (recommended)",id:"esm-config-recommended",level:3},{value:"CJS config (still supported)",id:"cjs-config-still-supported",level:3},{value:"Stylelint 17 breaking changes (summary)",id:"stylelint-17-breaking-changes-summary",level:2},{value:"Troubleshooting",id:"troubleshooting",level:2},{value:"<code>Unknown rule no-missing-end-of-source-newline</code>",id:"unknown-rule-no-missing-end-of-source-newline",level:3},{value:"<code>No rules found within configuration</code>",id:"no-rules-found-within-configuration",level:3},{value:"Styled-components files not linted",id:"styled-components-files-not-linted",level:3}];function h(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"stylelint-migration-guide-pui-cli-8--9--stylelint-17",children:"Stylelint migration guide (pui-cli 8 \u2192 9 / Stylelint 17)"})}),"\n",(0,s.jsxs)(n.p,{children:["This document covers Stylelint changes shipped with ",(0,s.jsx)(n.strong,{children:"pui-cli 9"})," (Stylelint ",(0,s.jsx)(n.strong,{children:"17.x"}),")."]}),"\n",(0,s.jsxs)(n.p,{children:["For the full pui-cli 9 upgrade path, see ",(0,s.jsx)(n.a,{href:"/cli/pui-cli-9-migration",children:"pui-cli 9 migration guide"}),"."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"at-a-glance",children:"At a glance"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Topic"}),(0,s.jsx)(n.th,{children:"Before (pui-cli 8)"}),(0,s.jsx)(n.th,{children:"After (pui-cli 9)"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:"Stylelint"}),(0,s.jsx)(n.td,{children:"15.x"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"17.x"})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:"Recommended preset"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"stylelint-config-recommended@14"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"stylelint-config-recommended@18"})})})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:"Styled-components"}),(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"stylelint-config-styled-components"})," in ",(0,s.jsx)(n.code,{children:"extends"})]}),(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.strong,{children:"Removed"})," \u2014 rules inlined in shared config"]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:"CSS-in-JS syntax"}),(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"stylelint-processor-styled-components"})," / processors"]}),(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"postcss-styled-syntax"})})," via ",(0,s.jsx)(n.code,{children:"customSyntax"})]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:"Config format"}),(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.code,{children:"stylelint.config.cjs"})," only"]}),(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"stylelint.config.mjs"})})," preferred; CJS still supported"]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:"Consumer import"}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"require('@elliemae/pui-cli').stylelintConfig"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"import { stylelintConfig } from '@elliemae/pui-cli/stylelint'"})})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h2,{id:"why-stylelint-config-styled-components-was-removed",children:["Why ",(0,s.jsx)(n.code,{children:"stylelint-config-styled-components"})," was removed"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"stylelint-config-styled-components@0.1.1"})," is unmaintained and references rules removed in Stylelint 17 (for example ",(0,s.jsx)(n.code,{children:"no-missing-end-of-source-newline"}),"). That caused config load failures after the Stylelint 17 upgrade."]}),"\n",(0,s.jsx)(n.p,{children:"The shared pui-cli config now inlines the small set of rules that package provided:"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Rule"}),(0,s.jsx)(n.th,{children:"Value"}),(0,s.jsx)(n.th,{children:"Notes"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"value-no-vendor-prefix"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"true"})}),(0,s.jsx)(n.td,{children:"Same as styled-components preset"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"property-no-vendor-prefix"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"true"})}),(0,s.jsx)(n.td,{children:"Same as styled-components preset"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"no-empty-source"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"null"})}),(0,s.jsx)(n.td,{children:"Styled template files may be empty"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"selector-type-no-unknown"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"null"})}),(0,s.jsx)(n.td,{children:"Allow styled-components DOM shims"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"function-no-unknown"})}),(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"null"})}),(0,s.jsx)(n.td,{children:"Allow CSS-in-JS helper functions"})]})]})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"how-to-upgrade-a-repo",children:"How to upgrade a repo"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["Upgrade ",(0,s.jsx)(n.code,{children:"@elliemae/pui-cli"})," to v9 (Stylelint 17 is bundled as a dependency)."]}),"\n",(0,s.jsx)(n.li,{children:"Replace your Stylelint config with the shared config (see below)."}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Delete"})," any local workaround that filters ",(0,s.jsx)(n.code,{children:"stylelint-config-styled-components"})," from ",(0,s.jsx)(n.code,{children:"extends"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:["Run ",(0,s.jsx)(n.code,{children:"pui-cli lint"})," (or ",(0,s.jsx)(n.code,{children:"pui-cli lint --css"}),")."]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"esm-config-recommended",children:"ESM config (recommended)"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"// stylelint.config.mjs\nimport { stylelintConfig } from '@elliemae/pui-cli/stylelint';\n\nexport default stylelintConfig;\n"})}),"\n",(0,s.jsx)(n.h3,{id:"cjs-config-still-supported",children:"CJS config (still supported)"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"// stylelint.config.cjs\nconst { stylelintConfig } = require('@elliemae/pui-cli');\nmodule.exports = stylelintConfig;\n"})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"pui-cli lint"})," auto-detects ",(0,s.jsx)(n.code,{children:"stylelint.config.mjs"})," first, then ",(0,s.jsx)(n.code,{children:"stylelint.config.cjs"}),"."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"stylelint-17-breaking-changes-summary",children:"Stylelint 17 breaking changes (summary)"}),"\n",(0,s.jsxs)(n.p,{children:["Stylelint 17 is ESM-only internally and requires ",(0,s.jsx)(n.strong,{children:"Node.js 20.19+"})," (pui-cli 9 requires Node 24). Notable changes that may affect CI or custom plugins:"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsxs)(n.strong,{children:["Default ",(0,s.jsx)(n.code,{children:"fix"})," mode"]})," is now ",(0,s.jsx)(n.code,{children:"strict"})," (fixes only when the whole file can be safely autofixed)."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Vendor-prefix rules"})," have consistent behaviour for ",(0,s.jsx)(n.code,{children:"ignore*: []"})," options."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Removed"})," legacy CommonJS API surface (",(0,s.jsx)(n.code,{children:"output"})," on resolved results, etc.)."]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Full upstream details: ",(0,s.jsx)(n.a,{href:"https://stylelint.io/migration-guide/to-17",children:"Stylelint 17 migration guide"}),"."]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,s.jsx)(n.h3,{id:"unknown-rule-no-missing-end-of-source-newline",children:(0,s.jsx)(n.code,{children:"Unknown rule no-missing-end-of-source-newline"})}),"\n",(0,s.jsxs)(n.p,{children:["A dependency or local config still extends ",(0,s.jsx)(n.code,{children:"stylelint-config-styled-components"})," or sets removed rules. Remove that extend and use the pui-cli shared config."]}),"\n",(0,s.jsx)(n.h3,{id:"no-rules-found-within-configuration",children:(0,s.jsx)(n.code,{children:"No rules found within configuration"})}),"\n",(0,s.jsxs)(n.p,{children:["The Stylelint CLI must receive a config whose ",(0,s.jsxs)(n.strong,{children:["default export / ",(0,s.jsx)(n.code,{children:"module.exports"})]})," is the config object \u2014 not ",(0,s.jsx)(n.code,{children:"{ stylelintConfig: { ... } }"}),". Re-export correctly:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:"module.exports = require('@elliemae/pui-cli').stylelintConfig;\n// or\nexport { stylelintConfig as default } from '@elliemae/pui-cli/stylelint';\n"})}),"\n",(0,s.jsx)(n.h3,{id:"styled-components-files-not-linted",children:"Styled-components files not linted"}),"\n",(0,s.jsxs)(n.p,{children:["Ensure files are included in the lint glob (",(0,s.jsx)(n.code,{children:"app/**"}),", ",(0,s.jsx)(n.code,{children:"lib/**"})," with ",(0,s.jsx)(n.code,{children:".{js,jsx,ts,tsx}"})," extensions). The shared config sets ",(0,s.jsx)(n.code,{children:"customSyntax: 'postcss-styled-syntax'"})," for CSS-in-JS."]})]})}function a(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},6607(e,n,i){i.d(n,{R:()=>d,x:()=>r});var l=i(758);const s={},t=l.createContext(s);function d(e){const n=l.useContext(t);return l.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:d(e.components),l.createElement(t.Provider,{value:n},e.children)}}}]);
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
"use strict";(globalThis.webpackChunk_elliemae_pui_cli=globalThis.webpackChunk_elliemae_pui_cli||[]).push([[2960],{8990(e,i,n){n.r(i),n.d(i,{assets:()=>o,contentTitle:()=>s,default:()=>p,frontMatter:()=>r,metadata:()=>t,toc:()=>c});const t=JSON.parse('{"id":"api/variables/prettierConfig","title":"prettierConfig","description":"Type Declaration","source":"@site/docs/api/variables/prettierConfig.md","sourceDirName":"api/variables","slug":"/api/variables/prettierConfig","permalink":"/cli/api/variables/prettierConfig","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-cli.git/docs/api/variables/prettierConfig.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"lintStagedConfig","permalink":"/cli/api/variables/lintStagedConfig"},"next":{"title":"stylelintConfig","permalink":"/cli/api/variables/stylelintConfig"}}');var a=n(6070),l=n(6607);const r={},s="prettierConfig",o={},c=[{value:"Type Declaration",id:"type-declaration",level:2},{value:"printWidth",id:"printwidth",level:3},{value:"semi",id:"semi",level:3},{value:"singleQuote",id:"singlequote",level:3},{value:"tabWidth",id:"tabwidth",level:3},{value:"trailingComma",id:"trailingcomma",level:3},{value:"useTabs",id:"usetabs",level:3}];function d(e){const i={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",pre:"pre",...(0,l.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(i.header,{children:(0,a.jsx)(i.h1,{id:"prettierconfig",children:"prettierConfig"})}),"\n",(0,a.jsx)(i.pre,{children:(0,a.jsx)(i.code,{className:"language-ts",children:"prettierConfig: {\n printWidth: number;\n semi: boolean;\n singleQuote: boolean;\n tabWidth: number;\n trailingComma: string;\n useTabs: boolean;\n};\n"})}),"\n",(0,a.jsx)(i.h2,{id:"type-declaration",children:"Type Declaration"}),"\n",(0,a.jsx)(i.h3,{id:"printwidth",children:"printWidth"}),"\n",(0,a.jsx)(i.pre,{children:(0,a.jsx)(i.code,{className:"language-ts",children:"printWidth: number = 80;\n"})}),"\n",(0,a.jsx)(i.h3,{id:"semi",children:"semi"}),"\n",(0,a.jsx)(i.pre,{children:(0,a.jsx)(i.code,{className:"language-ts",children:"semi: boolean = true;\n"})}),"\n",(0,a.jsx)(i.h3,{id:"singlequote",children:"singleQuote"}),"\n",(0,a.jsx)(i.pre,{children:(0,a.jsx)(i.code,{className:"language-ts",children:"singleQuote: boolean = true;\n"})}),"\n",(0,a.jsx)(i.h3,{id:"tabwidth",children:"tabWidth"}),"\n",(0,a.jsx)(i.pre,{children:(0,a.jsx)(i.code,{className:"language-ts",children:"tabWidth: number = 2;\n"})}),"\n",(0,a.jsx)(i.h3,{id:"trailingcomma",children:"trailingComma"}),"\n",(0,a.jsx)(i.pre,{children:(0,a.jsx)(i.code,{className:"language-ts",children:"trailingComma: string = 'all';\n"})}),"\n",(0,a.jsx)(i.h3,{id:"usetabs",children:"useTabs"}),"\n",(0,a.jsx)(i.pre,{children:(0,a.jsx)(i.code,{className:"language-ts",children:"useTabs: boolean = false;\n"})})]})}function p(e={}){const{wrapper:i}={...(0,l.R)(),...e.components};return i?(0,a.jsx)(i,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},6607(e,i,n){n.d(i,{R:()=>r,x:()=>s});var t=n(758);const a={},l=t.createContext(a);function r(e){const i=t.useContext(l);return t.useMemo(function(){return"function"==typeof e?e(i):{...i,...e}},[i,e])}function s(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:r(e.components),t.createElement(l.Provider,{value:i},e.children)}}}]);
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
"use strict";(globalThis.webpackChunk_elliemae_pui_cli=globalThis.webpackChunk_elliemae_pui_cli||[]).push([[594],{2330(e,i,n){n.r(i),n.d(i,{assets:()=>c,contentTitle:()=>d,default:()=>o,frontMatter:()=>r,metadata:()=>t,toc:()=>a});const t=JSON.parse('{"id":"api/index","title":"Cli API","description":"Functions","source":"@site/docs/api/index.md","sourceDirName":"api","slug":"/api/","permalink":"/cli/api/","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-cli.git/docs/api/index.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","next":{"title":"loadRoutes()","permalink":"/cli/api/functions/loadRoutes"}}');var s=n(6070),l=n(6607);const r={},d="Cli API",c={},a=[{value:"Functions",id:"functions",level:2},{value:"Type Aliases",id:"type-aliases",level:2},{value:"Variables",id:"variables",level:2}];function h(e){const i={a:"a",code:"code",del:"del",h1:"h1",h2:"h2",header:"header",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,l.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(i.header,{children:(0,s.jsx)(i.h1,{id:"cli-api",children:"Cli API"})}),"\n",(0,s.jsx)(i.h2,{id:"functions",children:"Functions"}),"\n",(0,s.jsxs)(i.table,{children:[(0,s.jsx)(i.thead,{children:(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.th,{children:"Function"}),(0,s.jsx)(i.th,{children:"Description"})]})}),(0,s.jsx)(i.tbody,{children:(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.td,{children:(0,s.jsx)(i.a,{href:"/cli/api/functions/loadRoutes",children:"loadRoutes"})}),(0,s.jsx)(i.td,{children:"-"})]})})]}),"\n",(0,s.jsx)(i.h2,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,s.jsxs)(i.table,{children:[(0,s.jsx)(i.thead,{children:(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.th,{children:"Type Alias"}),(0,s.jsx)(i.th,{children:"Description"})]})}),(0,s.jsx)(i.tbody,{children:(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.td,{children:(0,s.jsx)(i.a,{href:"/cli/api/type-aliases/LIB_NAME",children:"LIB_NAME"})}),(0,s.jsx)(i.td,{children:"-"})]})})]}),"\n",(0,s.jsx)(i.h2,{id:"variables",children:"Variables"}),"\n",(0,s.jsxs)(i.table,{children:[(0,s.jsx)(i.thead,{children:(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.th,{children:"Variable"}),(0,s.jsx)(i.th,{children:"Description"})]})}),(0,s.jsxs)(i.tbody,{children:[(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.td,{children:(0,s.jsx)(i.a,{href:"/cli/api/variables/babelConfig",children:"babelConfig"})}),(0,s.jsx)(i.td,{children:"-"})]}),(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.td,{children:(0,s.jsx)(i.a,{href:"/cli/api/variables/commitlintConfig",children:"commitlintConfig"})}),(0,s.jsx)(i.td,{children:"-"})]}),(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.td,{children:(0,s.jsx)(i.a,{href:"/cli/api/variables/eslintBaseConfig",children:(0,s.jsx)(i.del,{children:"eslintBaseConfig"})})}),(0,s.jsx)(i.td,{children:"-"})]}),(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.td,{children:(0,s.jsx)(i.a,{href:"/cli/api/variables/eslintConfig",children:(0,s.jsx)(i.del,{children:"eslintConfig"})})}),(0,s.jsx)(i.td,{children:"-"})]}),(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.td,{children:(0,s.jsx)(i.a,{href:"/cli/api/variables/eslintFlatBaseConfig",children:"eslintFlatBaseConfig"})}),(0,s.jsx)(i.td,{children:"Flat ESLint config for non-React TypeScript libraries and services."})]}),(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.td,{children:(0,s.jsx)(i.a,{href:"/cli/api/variables/eslintFlatBaseConfigStrict",children:"eslintFlatBaseConfigStrict"})}),(0,s.jsxs)(i.td,{children:["Strict flat ESLint config for non-React TypeScript (",(0,s.jsx)(i.code,{children:"no-unsafe-*"})," as error)."]})]}),(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.td,{children:(0,s.jsx)(i.a,{href:"/cli/api/variables/eslintFlatConfig",children:"eslintFlatConfig"})}),(0,s.jsx)(i.td,{children:"Flat ESLint config for React + TypeScript PUI apps."})]}),(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.td,{children:(0,s.jsx)(i.a,{href:"/cli/api/variables/eslintFlatConfigStrict",children:"eslintFlatConfigStrict"})}),(0,s.jsxs)(i.td,{children:["Strict flat ESLint config for React + TypeScript (errors on ",(0,s.jsx)(i.code,{children:"no-unsafe-*"})," and ",(0,s.jsx)(i.code,{children:"exhaustive-deps"}),")."]})]}),(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.td,{children:(0,s.jsx)(i.a,{href:"/cli/api/variables/jestConfig",children:"jestConfig"})}),(0,s.jsx)(i.td,{children:"-"})]}),(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.td,{children:(0,s.jsx)(i.a,{href:"/cli/api/variables/jestNodeConfig",children:"jestNodeConfig"})}),(0,s.jsx)(i.td,{children:"-"})]}),(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.td,{children:(0,s.jsx)(i.a,{href:"/cli/api/variables/lintStagedConfig",children:"lintStagedConfig"})}),(0,s.jsx)(i.td,{children:"-"})]}),(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.td,{children:(0,s.jsx)(i.a,{href:"/cli/api/variables/prettierConfig",children:"prettierConfig"})}),(0,s.jsx)(i.td,{children:"-"})]}),(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.td,{children:(0,s.jsx)(i.a,{href:"/cli/api/variables/stylelintConfig",children:"stylelintConfig"})}),(0,s.jsx)(i.td,{children:"-"})]}),(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.td,{children:(0,s.jsx)(i.a,{href:"/cli/api/variables/vitestConfig",children:"vitestConfig"})}),(0,s.jsx)(i.td,{children:"-"})]})]})]})]})}function o(e={}){const{wrapper:i}={...(0,l.R)(),...e.components};return i?(0,s.jsx)(i,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},6607(e,i,n){n.d(i,{R:()=>r,x:()=>d});var t=n(758);const s={},l=t.createContext(s);function r(e){const i=t.useContext(l);return t.useMemo(function(){return"function"==typeof e?e(i):{...i,...e}},[i,e])}function d(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),t.createElement(l.Provider,{value:i},e.children)}}}]);
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
"use strict";(globalThis.webpackChunk_elliemae_pui_cli=globalThis.webpackChunk_elliemae_pui_cli||[]).push([[9647],{3156(e,l,a){a.r(l),a.d(l,{default:()=>n});a(758);var i=a(3526),s=a(3386),r=a(4485),u=a(389),c=a(4775),h=a(6070);function n(e){return(0,h.jsx)(r.e3,{className:(0,i.A)(s.G.wrapper.docsPages),children:(0,h.jsx)(c.A,{children:(0,u.v)(e.route.routes)})})}}}]);
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
"use strict";(globalThis.webpackChunk_elliemae_pui_cli=globalThis.webpackChunk_elliemae_pui_cli||[]).push([[2113],{3173(s,e,t){t.r(e),t.d(e,{assets:()=>o,contentTitle:()=>r,default:()=>x,frontMatter:()=>l,metadata:()=>n,toc:()=>c});const n=JSON.parse('{"id":"api/variables/lintStagedConfig","title":"lintStagedConfig","description":"Type Declaration","source":"@site/docs/api/variables/lintStagedConfig.md","sourceDirName":"api/variables","slug":"/api/variables/lintStagedConfig","permalink":"/cli/api/variables/lintStagedConfig","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-cli.git/docs/api/variables/lintStagedConfig.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"jestNodeConfig","permalink":"/cli/api/variables/jestNodeConfig"},"next":{"title":"prettierConfig","permalink":"/cli/api/variables/prettierConfig"}}');var i=t(6070),a=t(6607);const l={},r="lintStagedConfig",o={},c=[{value:"Type Declaration",id:"type-declaration",level:2},{value:"*.{js,ts,jsx,tsx,md,mdx,html,css,json}",id:"jstsjsxtsxmdmdxhtmlcssjson",level:4},{value:"*.{js,ts,jsx,tsx}",id:"jstsjsxtsx",level:4},{value:"*.{ts,tsx}",id:"tstsx",level:4}];function d(s){const e={code:"code",h1:"h1",h2:"h2",h4:"h4",header:"header",pre:"pre",...(0,a.R)(),...s.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.header,{children:(0,i.jsx)(e.h1,{id:"lintstagedconfig",children:"lintStagedConfig"})}),"\n",(0,i.jsx)(e.pre,{children:(0,i.jsx)(e.code,{className:"language-ts",children:"const lintStagedConfig: {\n *.{js,ts,jsx,tsx,md,mdx,html,css,json}: string[];\n *.{js,ts,jsx,tsx}: string[];\n *.{ts,tsx}: string[];\n};\n"})}),"\n",(0,i.jsx)(e.h2,{id:"type-declaration",children:"Type Declaration"}),"\n",(0,i.jsx)(e.h4,{id:"jstsjsxtsxmdmdxhtmlcssjson",children:"*.{js,ts,jsx,tsx,md,mdx,html,css,json}"}),"\n",(0,i.jsx)(e.pre,{children:(0,i.jsx)(e.code,{className:"language-ts",children:"*.{js,ts,jsx,tsx,md,mdx,html,css,json}: string[];\n"})}),"\n",(0,i.jsx)(e.h4,{id:"jstsjsxtsx",children:"*.{js,ts,jsx,tsx}"}),"\n",(0,i.jsx)(e.pre,{children:(0,i.jsx)(e.code,{className:"language-ts",children:"*.{js,ts,jsx,tsx}: string[];\n"})}),"\n",(0,i.jsx)(e.h4,{id:"tstsx",children:"*.{ts,tsx}"}),"\n",(0,i.jsx)(e.pre,{children:(0,i.jsx)(e.code,{className:"language-ts",children:"*.{ts,tsx}: string[];\n"})})]})}function x(s={}){const{wrapper:e}={...(0,a.R)(),...s.components};return e?(0,i.jsx)(e,{...s,children:(0,i.jsx)(d,{...s})}):d(s)}},6607(s,e,t){t.d(e,{R:()=>l,x:()=>r});var n=t(758);const i={},a=n.createContext(i);function l(s){const e=n.useContext(a);return n.useMemo(function(){return"function"==typeof s?s(e):{...e,...s}},[e,s])}function r(s){let e;return e=s.disableParentContext?"function"==typeof s.components?s.components(i):s.components||i:l(s.components),n.createElement(a.Provider,{value:e},s.children)}}}]);
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
"use strict";(globalThis.webpackChunk_elliemae_pui_cli=globalThis.webpackChunk_elliemae_pui_cli||[]).push([[6688],{3869(e,n,s){s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>c,frontMatter:()=>i,metadata:()=>r,toc:()=>d});const r=JSON.parse('{"id":"api/variables/jestNodeConfig","title":"jestNodeConfig","description":"Type Declaration","source":"@site/docs/api/variables/jestNodeConfig.md","sourceDirName":"api/variables","slug":"/api/variables/jestNodeConfig","permalink":"/cli/api/variables/jestNodeConfig","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-cli.git/docs/api/variables/jestNodeConfig.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"jestConfig","permalink":"/cli/api/variables/jestConfig"},"next":{"title":"lintStagedConfig","permalink":"/cli/api/variables/lintStagedConfig"}}');var a=s(6070),l=s(6607);const i={},t="jestNodeConfig",o={},d=[{value:"Type Declaration",id:"type-declaration",level:2},{value:"collectCoverageFrom",id:"collectcoveragefrom",level:3},{value:"coverageDirectory",id:"coveragedirectory",level:3},{value:"coverageReporters",id:"coveragereporters",level:3},{value:"coverageThreshold",id:"coveragethreshold",level:3},{value:"globals",id:"globals",level:3},{value:"globals.__webpack_public_path__",id:"globals__webpack_public_path__",level:4},{value:"globals.APP_CONFIG",id:"globalsapp_config",level:4},{value:"moduleDirectories",id:"moduledirectories",level:3},{value:"moduleFileExtensions",id:"modulefileextensions",level:3},{value:"moduleNameMapper",id:"modulenamemapper",level:3},{value:"moduleNameMapper..*.(css|scss)$",id:"modulenamemappercssscss",level:4},{value:"moduleNameMapper..*.(jpg|jpeg|png|gif|eot|otf|webp|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga|ico)$",id:"modulenamemapperjpgjpegpnggifeototfwebpttfwoffwoff2mp4webmwavmp3m4aaacogaico",level:4},{value:"moduleNameMapper..*.html(?:?[a-zA-Z]+)?$",id:"modulenamemapperhtmla-za-z",level:4},{value:"moduleNameMapper..*.svg(?:?[a-zA-Z]+)?$",id:"modulenamemappersvga-za-z",level:4},{value:"moduleNameMapper..*\\webpack-hmr(.[t|j]s)?$",id:"modulenamemapperwebpack-hmrtjs",level:4},{value:"moduleNameMapper..*frame.html(?:?[a-zA-Z]+)?$",id:"modulenamemapperframehtmla-za-z",level:4},{value:"moduleNameMapper..*iframe.html(?:?[a-zA-Z]+)?$",id:"modulenamemapperiframehtmla-za-z",level:4},{value:"moduleNameMapper.@elliemae/pui-app-loader",id:"modulenamemapperelliemaepui-app-loader",level:4},{value:"moduleNameMapper.@elliemae/pui-diagnostics",id:"modulenamemapperelliemaepui-diagnostics",level:4},{value:"moduleNameMapper.@elliemae/pui-logrocket",id:"modulenamemapperelliemaepui-logrocket",level:4},{value:"moduleNameMapper.@elliemae/pui-user-monitoring",id:"modulenamemapperelliemaepui-user-monitoring",level:4},{value:"moduleNameMapper.^d3-(.*)$",id:"modulenamemapperd3-",level:4},{value:"moduleNameMapper.d3",id:"modulenamemapperd3",level:4},{value:"moduleNameMapper.react-spring/renderprops",id:"modulenamemapperreact-springrenderprops",level:4},{value:"moduleNameMapper.react-spring/web",id:"modulenamemapperreact-springweb",level:4},{value:"resolver",id:"resolver",level:3},{value:"setupFiles",id:"setupfiles",level:3},{value:"setupFilesAfterEnv",id:"setupfilesafterenv",level:3},{value:"snapshotSerializers",id:"snapshotserializers",level:3},{value:"testEnvironment",id:"testenvironment",level:3},{value:"testEnvironmentOptions",id:"testenvironmentoptions",level:3},{value:"testEnvironmentOptions.resources",id:"testenvironmentoptionsresources",level:4},{value:"testEnvironmentOptions.url",id:"testenvironmentoptionsurl",level:4},{value:"testRegex",id:"testregex",level:3},{value:"testResultsProcessor",id:"testresultsprocessor",level:3},{value:"testTimeout",id:"testtimeout",level:3},{value:"transform",id:"transform",level:3},{value:"transform.^.+.[jt]sx?$",id:"transformjtsx",level:4},{value:"transformIgnorePatterns",id:"transformignorepatterns",level:3},{value:"watchPlugins",id:"watchplugins",level:3}];function p(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",pre:"pre",...(0,l.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.header,{children:(0,a.jsx)(n.h1,{id:"jestnodeconfig",children:"jestNodeConfig"})}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"jestNodeConfig: {\n collectCoverageFrom: string[];\n coverageDirectory: string;\n coverageReporters: string[];\n coverageThreshold: {\n };\n globals: {\n __webpack_public_path__: string;\n APP_CONFIG: string | NonSharedBuffer;\n };\n moduleDirectories: string[];\n moduleFileExtensions: string[];\n moduleNameMapper: {\n .*\\.(css|scss)$: string;\n .*\\.(jpg|jpeg|png|gif|eot|otf|webp|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga|ico)$: string;\n .*\\.html(?:\\?[a-zA-Z]+)?$: string;\n .*\\.svg(?:\\?[a-zA-Z]+)?$: string;\n .*\\webpack-hmr(.[t|j]s)?$: string;\n .*frame\\.html(?:\\?[a-zA-Z]+)?$: string;\n .*iframe\\.html(?:\\?[a-zA-Z]+)?$: string;\n @elliemae/pui-app-loader: string;\n @elliemae/pui-diagnostics: string;\n @elliemae/pui-logrocket: string;\n @elliemae/pui-user-monitoring: string;\n ^d3-(.*)$: string;\n d3: string;\n react-spring/renderprops: string;\n react-spring/web: string;\n };\n resolver: string;\n setupFiles: never[];\n setupFilesAfterEnv: never[];\n snapshotSerializers: never[];\n testEnvironment: string;\n testEnvironmentOptions: {\n resources: string;\n url: string;\n };\n testRegex: string;\n testResultsProcessor: string;\n testTimeout: number;\n transform: {\n ^.+\\.[jt]sx?$: any[];\n };\n transformIgnorePatterns: never[];\n watchPlugins: string[];\n};\n"})}),"\n",(0,a.jsx)(n.h2,{id:"type-declaration",children:"Type Declaration"}),"\n",(0,a.jsx)(n.h3,{id:"collectcoveragefrom",children:"collectCoverageFrom"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"collectCoverageFrom: string[];\n"})}),"\n",(0,a.jsx)(n.h3,{id:"coveragedirectory",children:"coverageDirectory"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"coverageDirectory: string = 'reports';\n"})}),"\n",(0,a.jsx)(n.h3,{id:"coveragereporters",children:"coverageReporters"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"coverageReporters: string[];\n"})}),"\n",(0,a.jsx)(n.h3,{id:"coveragethreshold",children:"coverageThreshold"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"coverageThreshold: {\n} = {};\n"})}),"\n",(0,a.jsx)(n.h3,{id:"globals",children:"globals"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"globals: {\n __webpack_public_path__: string;\n APP_CONFIG: string | NonSharedBuffer;\n};\n"})}),"\n",(0,a.jsx)(n.h4,{id:"globals__webpack_public_path__",children:"globals.__webpack_public_path__"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"__webpack_public_path__: string = '/';\n"})}),"\n",(0,a.jsx)(n.h4,{id:"globalsapp_config",children:"globals.APP_CONFIG"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"APP_CONFIG: string | NonSharedBuffer;\n"})}),"\n",(0,a.jsx)(n.h3,{id:"moduledirectories",children:"moduleDirectories"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"moduleDirectories: string[];\n"})}),"\n",(0,a.jsx)(n.h3,{id:"modulefileextensions",children:"moduleFileExtensions"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"moduleFileExtensions: string[];\n"})}),"\n",(0,a.jsx)(n.h3,{id:"modulenamemapper",children:"moduleNameMapper"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"moduleNameMapper: {\n .*\\.(css|scss)$: string;\n .*\\.(jpg|jpeg|png|gif|eot|otf|webp|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga|ico)$: string;\n .*\\.html(?:\\?[a-zA-Z]+)?$: string;\n .*\\.svg(?:\\?[a-zA-Z]+)?$: string;\n .*\\webpack-hmr(.[t|j]s)?$: string;\n .*frame\\.html(?:\\?[a-zA-Z]+)?$: string;\n .*iframe\\.html(?:\\?[a-zA-Z]+)?$: string;\n @elliemae/pui-app-loader: string;\n @elliemae/pui-diagnostics: string;\n @elliemae/pui-logrocket: string;\n @elliemae/pui-user-monitoring: string;\n ^d3-(.*)$: string;\n d3: string;\n react-spring/renderprops: string;\n react-spring/web: string;\n};\n"})}),"\n",(0,a.jsx)(n.h4,{id:"modulenamemappercssscss",children:"moduleNameMapper..*.(css|scss)$"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:".*\\.(css|scss)$: string;\n"})}),"\n",(0,a.jsx)(n.h4,{id:"modulenamemapperjpgjpegpnggifeototfwebpttfwoffwoff2mp4webmwavmp3m4aaacogaico",children:"moduleNameMapper..*.(jpg|jpeg|png|gif|eot|otf|webp|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga|ico)$"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:".*\\.(jpg|jpeg|png|gif|eot|otf|webp|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga|ico)$: string;\n"})}),"\n",(0,a.jsx)(n.h4,{id:"modulenamemapperhtmla-za-z",children:"moduleNameMapper..*.html(?:?[a-zA-Z]+)?$"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:".*\\.html(?:\\?[a-zA-Z]+)?$: string;\n"})}),"\n",(0,a.jsx)(n.h4,{id:"modulenamemappersvga-za-z",children:"moduleNameMapper..*.svg(?:?[a-zA-Z]+)?$"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:".*\\.svg(?:\\?[a-zA-Z]+)?$: string;\n"})}),"\n",(0,a.jsx)(n.h4,{id:"modulenamemapperwebpack-hmrtjs",children:"moduleNameMapper..*\\webpack-hmr(.[t|j]s)?$"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:".*\\webpack-hmr(.[t|j]s)?$: string;\n"})}),"\n",(0,a.jsx)(n.h4,{id:"modulenamemapperframehtmla-za-z",children:"moduleNameMapper..*frame.html(?:?[a-zA-Z]+)?$"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:".*frame\\.html(?:\\?[a-zA-Z]+)?$: string;\n"})}),"\n",(0,a.jsx)(n.h4,{id:"modulenamemapperiframehtmla-za-z",children:"moduleNameMapper..*iframe.html(?:?[a-zA-Z]+)?$"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:".*iframe\\.html(?:\\?[a-zA-Z]+)?$: string;\n"})}),"\n",(0,a.jsx)(n.h4,{id:"modulenamemapperelliemaepui-app-loader",children:"moduleNameMapper.@elliemae/pui-app-loader"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"@elliemae/pui-app-loader: string;\n"})}),"\n",(0,a.jsx)(n.h4,{id:"modulenamemapperelliemaepui-diagnostics",children:"moduleNameMapper.@elliemae/pui-diagnostics"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"@elliemae/pui-diagnostics: string;\n"})}),"\n",(0,a.jsx)(n.h4,{id:"modulenamemapperelliemaepui-logrocket",children:"moduleNameMapper.@elliemae/pui-logrocket"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"@elliemae/pui-logrocket: string;\n"})}),"\n",(0,a.jsx)(n.h4,{id:"modulenamemapperelliemaepui-user-monitoring",children:"moduleNameMapper.@elliemae/pui-user-monitoring"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"@elliemae/pui-user-monitoring: string;\n"})}),"\n",(0,a.jsx)(n.h4,{id:"modulenamemapperd3-",children:"moduleNameMapper.^d3-(.*)$"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"^d3-(.*)$: string = '<rootDir>/node_modules/d3-$1/dist/d3-$1.min.js';\n"})}),"\n",(0,a.jsx)(n.h4,{id:"modulenamemapperd3",children:"moduleNameMapper.d3"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"d3: string = '<rootDir>/node_modules/d3/dist/d3.min.js';\n"})}),"\n",(0,a.jsx)(n.h4,{id:"modulenamemapperreact-springrenderprops",children:"moduleNameMapper.react-spring/renderprops"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"react-spring/renderprops: string;\n"})}),"\n",(0,a.jsx)(n.h4,{id:"modulenamemapperreact-springweb",children:"moduleNameMapper.react-spring/web"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"react-spring/web: string;\n"})}),"\n",(0,a.jsx)(n.h3,{id:"resolver",children:"resolver"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"resolver: string;\n"})}),"\n",(0,a.jsx)(n.h3,{id:"setupfiles",children:"setupFiles"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"setupFiles: never[] = [];\n"})}),"\n",(0,a.jsx)(n.h3,{id:"setupfilesafterenv",children:"setupFilesAfterEnv"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"setupFilesAfterEnv: never[] = [];\n"})}),"\n",(0,a.jsx)(n.h3,{id:"snapshotserializers",children:"snapshotSerializers"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"snapshotSerializers: never[] = [];\n"})}),"\n",(0,a.jsx)(n.h3,{id:"testenvironment",children:"testEnvironment"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"testEnvironment: string = 'node';\n"})}),"\n",(0,a.jsx)(n.h3,{id:"testenvironmentoptions",children:"testEnvironmentOptions"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"testEnvironmentOptions: {\n resources: string;\n url: string;\n};\n"})}),"\n",(0,a.jsx)(n.h4,{id:"testenvironmentoptionsresources",children:"testEnvironmentOptions.resources"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"resources: string = 'usable';\n"})}),"\n",(0,a.jsx)(n.h4,{id:"testenvironmentoptionsurl",children:"testEnvironmentOptions.url"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"url: string;\n"})}),"\n",(0,a.jsx)(n.h3,{id:"testregex",children:"testRegex"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"testRegex: string = '(app|lib).*/tests/.*\\.test\\.[jt]sx?$';\n"})}),"\n",(0,a.jsx)(n.h3,{id:"testresultsprocessor",children:"testResultsProcessor"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"testResultsProcessor: string = 'jest-sonar-reporter';\n"})}),"\n",(0,a.jsx)(n.h3,{id:"testtimeout",children:"testTimeout"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"testTimeout: number = 5000;\n"})}),"\n",(0,a.jsx)(n.h3,{id:"transform",children:"transform"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"transform: {\n ^.+\\.[jt]sx?$: any[];\n};\n"})}),"\n",(0,a.jsx)(n.h4,{id:"transformjtsx",children:"transform.^.+.[jt]sx?$"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"^.+\\.[jt]sx?$: any[];\n"})}),"\n",(0,a.jsx)(n.h3,{id:"transformignorepatterns",children:"transformIgnorePatterns"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"transformIgnorePatterns: never[] = [];\n"})}),"\n",(0,a.jsx)(n.h3,{id:"watchplugins",children:"watchPlugins"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"watchPlugins: string[];\n"})})]})}function c(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(p,{...e})}):p(e)}},6607(e,n,s){s.d(n,{R:()=>i,x:()=>t});var r=s(758);const a={},l=r.createContext(a);function i(e){const n=r.useContext(l);return r.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:i(e.components),r.createElement(l.Provider,{value:n},e.children)}}}]);
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
"use strict";(globalThis.webpackChunk_elliemae_pui_cli=globalThis.webpackChunk_elliemae_pui_cli||[]).push([[4676],{8680(n,e,i){i.r(e),i.d(e,{assets:()=>o,contentTitle:()=>a,default:()=>c,frontMatter:()=>t,metadata:()=>s,toc:()=>g});const s=JSON.parse('{"id":"api/variables/babelConfig","title":"babelConfig","description":"Type Declaration","source":"@site/docs/api/variables/babelConfig.md","sourceDirName":"api/variables","slug":"/api/variables/babelConfig","permalink":"/cli/api/variables/babelConfig","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-cli.git/docs/api/variables/babelConfig.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"LIB\\\\_NAME","permalink":"/cli/api/type-aliases/LIB_NAME"},"next":{"title":"commitlintConfig","permalink":"/cli/api/variables/commitlintConfig"}}');var r=i(6070),l=i(6607);const t={},a="babelConfig",o={},g=[{value:"Type Declaration",id:"type-declaration",level:2},{value:"env",id:"env",level:3},{value:"env.development",id:"envdevelopment",level:4},{value:"env.development.plugins",id:"envdevelopmentplugins",level:4},{value:"env.production",id:"envproduction",level:4},{value:"env.production.plugins",id:"envproductionplugins",level:4},{value:"env.test",id:"envtest",level:4},{value:"env.test.plugins",id:"envtestplugins",level:4},{value:"ignore",id:"ignore",level:3},{value:"plugins",id:"plugins",level:3},{value:"presets",id:"presets",level:3},{value:"sourceType",id:"sourcetype",level:3}];function d(n){const e={code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",pre:"pre",...(0,l.R)(),...n.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(e.header,{children:(0,r.jsx)(e.h1,{id:"babelconfig",children:"babelConfig"})}),"\n",(0,r.jsx)(e.pre,{children:(0,r.jsx)(e.code,{className:"language-ts",children:"const babelConfig: {\n env: {\n development: {\n plugins: (\n | string\n | (\n | string\n | {\n displayName: boolean;\n })[])[];\n };\n production: {\n plugins: (\n | string\n | (\n | string\n | {\n displayName: boolean;\n pure: boolean;\n })[]\n | (\n | string\n | {\n exclude: string[];\n })[])[];\n };\n test: {\n plugins: (\n | string\n | (\n | string\n | {\n displayName: boolean;\n })[]\n | (\n | string\n | {\n identifiers: {\n end: string;\n start: string;\n }[];\n requireDirective: boolean;\n })[])[];\n };\n };\n ignore: RegExp[];\n plugins: (\n | string\n | (\n | string\n | {\n alias: {\n @: string;\n };\n stripExtensions: never[];\n })[]\n | (\n | string\n | {\n displayName: boolean;\n })[]\n | (\n | string\n | {\n regenerator: boolean;\n })[])[];\n presets: (\n | string\n | (\n | string\n | {\n modules: string | boolean;\n targets: {\n node: string;\n };\n }\n | {\n corejs: {\n proposals: boolean;\n version: string;\n };\n modules: string | boolean;\n useBuiltIns: string;\n })[]\n | (\n | string\n | {\n runtime: string;\n })[])[];\n sourceType: string;\n};\n"})}),"\n",(0,r.jsx)(e.h2,{id:"type-declaration",children:"Type Declaration"}),"\n",(0,r.jsx)(e.h3,{id:"env",children:"env"}),"\n",(0,r.jsx)(e.pre,{children:(0,r.jsx)(e.code,{className:"language-ts",children:"env: {\n development: {\n plugins: (\n | string\n | (\n | string\n | {\n displayName: boolean;\n })[])[];\n };\n production: {\n plugins: (\n | string\n | (\n | string\n | {\n displayName: boolean;\n pure: boolean;\n })[]\n | (\n | string\n | {\n exclude: string[];\n })[])[];\n };\n test: {\n plugins: (\n | string\n | (\n | string\n | {\n displayName: boolean;\n })[]\n | (\n | string\n | {\n identifiers: {\n end: string;\n start: string;\n }[];\n requireDirective: boolean;\n })[])[];\n };\n};\n"})}),"\n",(0,r.jsx)(e.h4,{id:"envdevelopment",children:"env.development"}),"\n",(0,r.jsx)(e.pre,{children:(0,r.jsx)(e.code,{className:"language-ts",children:"development: {\n plugins: (\n | string\n | (\n | string\n | {\n displayName: boolean;\n })[])[];\n};\n"})}),"\n",(0,r.jsx)(e.h4,{id:"envdevelopmentplugins",children:"env.development.plugins"}),"\n",(0,r.jsx)(e.pre,{children:(0,r.jsx)(e.code,{className:"language-ts",children:"plugins: (\n | string\n | (\n | string\n | {\n displayName: boolean;\n})[])[];\n"})}),"\n",(0,r.jsx)(e.h4,{id:"envproduction",children:"env.production"}),"\n",(0,r.jsx)(e.pre,{children:(0,r.jsx)(e.code,{className:"language-ts",children:"production: {\n plugins: (\n | string\n | (\n | string\n | {\n displayName: boolean;\n pure: boolean;\n })[]\n | (\n | string\n | {\n exclude: string[];\n })[])[];\n};\n"})}),"\n",(0,r.jsx)(e.h4,{id:"envproductionplugins",children:"env.production.plugins"}),"\n",(0,r.jsx)(e.pre,{children:(0,r.jsx)(e.code,{className:"language-ts",children:"plugins: (\n | string\n | (\n | string\n | {\n displayName: boolean;\n pure: boolean;\n})[]\n | (\n | string\n | {\n exclude: string[];\n})[])[];\n"})}),"\n",(0,r.jsx)(e.h4,{id:"envtest",children:"env.test"}),"\n",(0,r.jsx)(e.pre,{children:(0,r.jsx)(e.code,{className:"language-ts",children:"test: {\n plugins: (\n | string\n | (\n | string\n | {\n displayName: boolean;\n })[]\n | (\n | string\n | {\n identifiers: {\n end: string;\n start: string;\n }[];\n requireDirective: boolean;\n })[])[];\n};\n"})}),"\n",(0,r.jsx)(e.h4,{id:"envtestplugins",children:"env.test.plugins"}),"\n",(0,r.jsx)(e.pre,{children:(0,r.jsx)(e.code,{className:"language-ts",children:"plugins: (\n | string\n | (\n | string\n | {\n displayName: boolean;\n})[]\n | (\n | string\n | {\n identifiers: {\n end: string;\n start: string;\n }[];\n requireDirective: boolean;\n})[])[];\n"})}),"\n",(0,r.jsx)(e.h3,{id:"ignore",children:"ignore"}),"\n",(0,r.jsx)(e.pre,{children:(0,r.jsx)(e.code,{className:"language-ts",children:"ignore: RegExp[];\n"})}),"\n",(0,r.jsx)(e.h3,{id:"plugins",children:"plugins"}),"\n",(0,r.jsx)(e.pre,{children:(0,r.jsx)(e.code,{className:"language-ts",children:"plugins: (\n | string\n | (\n | string\n | {\n alias: {\n @: string;\n };\n stripExtensions: never[];\n})[]\n | (\n | string\n | {\n displayName: boolean;\n})[]\n | (\n | string\n | {\n regenerator: boolean;\n})[])[];\n"})}),"\n",(0,r.jsx)(e.h3,{id:"presets",children:"presets"}),"\n",(0,r.jsx)(e.pre,{children:(0,r.jsx)(e.code,{className:"language-ts",children:"presets: (\n | string\n | (\n | string\n | {\n modules: string | boolean;\n targets: {\n node: string;\n };\n}\n | {\n corejs: {\n proposals: boolean;\n version: string;\n };\n modules: string | boolean;\n useBuiltIns: string;\n})[]\n | (\n | string\n | {\n runtime: string;\n})[])[];\n"})}),"\n",(0,r.jsx)(e.h3,{id:"sourcetype",children:"sourceType"}),"\n",(0,r.jsx)(e.pre,{children:(0,r.jsx)(e.code,{className:"language-ts",children:"sourceType: string = 'unambiguous';\n"})})]})}function c(n={}){const{wrapper:e}={...(0,l.R)(),...n.components};return e?(0,r.jsx)(e,{...n,children:(0,r.jsx)(d,{...n})}):d(n)}},6607(n,e,i){i.d(e,{R:()=>t,x:()=>a});var s=i(758);const r={},l=s.createContext(r);function t(n){const e=s.useContext(l);return s.useMemo(function(){return"function"==typeof n?n(e):{...e,...n}},[e,n])}function a(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(r):n.components||r:t(n.components),s.createElement(l.Provider,{value:e},n.children)}}}]);
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
"use strict";(globalThis.webpackChunk_elliemae_pui_cli=globalThis.webpackChunk_elliemae_pui_cli||[]).push([[9048],{5433(e,t,n){n.r(t),n.d(t,{default:()=>Se});var a=n(758),i=n(3526),s=n(4485),o=n(3386),l=n(7272),r=n(2490),c=n(2984),d=n(8393),u=n(2055);const m="backToTopButton_j5oK",h="backToTopButtonShow_qpCy";var b=n(6070);function p(){const{shown:e,scrollToTop:t}=function({threshold:e}){const[t,n]=(0,a.useState)(!1),i=(0,a.useRef)(!1),{startScroll:s,cancelScroll:o}=(0,d.gk)();return(0,d.Mq)(({scrollY:t},a)=>{const s=a?.scrollY;s&&(i.current?i.current=!1:t>=s?(o(),n(!1)):t<e?n(!1):t+window.innerHeight<document.documentElement.scrollHeight&&n(!0))}),(0,u.$)(e=>{e.location.hash&&(i.current=!0,n(!1))}),{shown:t,scrollToTop:()=>s(0)}}({threshold:300});return(0,b.jsx)("button",{"aria-label":(0,c.T)({id:"theme.BackToTopButton.buttonAriaLabel",message:"Scroll back to top",description:"The ARIA label for the back to top button"}),className:(0,i.A)("clean-btn",o.G.common.backToTopButton,m,e&&h),type:"button",onClick:t})}var x=n(8122),j=n(5557),f=n(5284),_=n(2041),g=n(9716);function v(e){return(0,b.jsx)("svg",{width:"20",height:"20","aria-hidden":"true",...e,children:(0,b.jsxs)("g",{fill:"#7a7a7a",children:[(0,b.jsx)("path",{d:"M9.992 10.023c0 .2-.062.399-.172.547l-4.996 7.492a.982.982 0 01-.828.454H1c-.55 0-1-.453-1-1 0-.2.059-.403.168-.551l4.629-6.942L.168 3.078A.939.939 0 010 2.528c0-.548.45-.997 1-.997h2.996c.352 0 .649.18.828.45L9.82 9.472c.11.148.172.347.172.55zm0 0"}),(0,b.jsx)("path",{d:"M19.98 10.023c0 .2-.058.399-.168.547l-4.996 7.492a.987.987 0 01-.828.454h-3c-.547 0-.996-.453-.996-1 0-.2.059-.403.168-.551l4.625-6.942-4.625-6.945a.939.939 0 01-.168-.55 1 1 0 01.996-.997h3c.348 0 .649.18.828.45l4.996 7.492c.11.148.168.347.168.55zm0 0"})]})})}const C="collapseSidebarButton_1DCZ",A="collapseSidebarButtonIcon_BQRG";function k({onClick:e}){return(0,b.jsx)("button",{type:"button",title:(0,c.T)({id:"theme.docs.sidebar.collapseButtonTitle",message:"Collapse sidebar",description:"The title attribute for collapse button of doc sidebar"}),"aria-label":(0,c.T)({id:"theme.docs.sidebar.collapseButtonAriaLabel",message:"Collapse sidebar",description:"The title attribute for collapse button of doc sidebar"}),className:(0,i.A)("button button--secondary button--outline",C),onClick:e,children:(0,b.jsx)(v,{className:A})})}var S=n(3582),N=n(8243);const T=Symbol("EmptyContext"),y=a.createContext(T);function I({children:e}){const[t,n]=(0,a.useState)(null),i=(0,a.useMemo)(()=>({expandedItem:t,setExpandedItem:n}),[t]);return(0,b.jsx)(y.Provider,{value:i,children:e})}var L=n(6153),w=n(4640),E=n(6258),B=n(899),H=n(1306),M=n(8346);const P="menuExternalLink_nyHq",G="linkLabel_gjq0";function R({label:e}){return(0,b.jsx)("span",{title:e,className:G,children:e})}function D({item:e,onItemClick:t,activePath:n,level:a,index:s,...r}){const{href:c,label:d,className:u,autoAddBaseUrl:m}=e,h=(0,l.w8)(e,n),p=(0,H.A)(c);return(0,b.jsx)("li",{className:(0,i.A)(o.G.docs.docSidebarItemLink,o.G.docs.docSidebarItemLinkLevel(a),"menu__list-item",u),children:(0,b.jsxs)(E.A,{className:(0,i.A)("menu__link",!p&&P,{"menu__link--active":h}),autoAddBaseUrl:m,"aria-current":h?"page":void 0,to:c,...p&&{onClick:t?()=>t(e):void 0},...r,children:[(0,b.jsx)(R,{label:d}),!p&&(0,b.jsx)(M.A,{})]})},d)}const W="categoryLink_jyam",V="categoryLinkLabel_sc1K";function F({collapsed:e,categoryLabel:t,onClick:n}){return(0,b.jsx)("button",{"aria-label":e?(0,c.T)({id:"theme.DocSidebarItem.expandCategoryAriaLabel",message:"Expand sidebar category '{label}'",description:"The ARIA label to expand the sidebar category"},{label:t}):(0,c.T)({id:"theme.DocSidebarItem.collapseCategoryAriaLabel",message:"Collapse sidebar category '{label}'",description:"The ARIA label to collapse the sidebar category"},{label:t}),"aria-expanded":!e,type:"button",className:"clean-btn menu__caret",onClick:n})}function U({label:e}){return(0,b.jsx)("span",{title:e,className:V,children:e})}function q(e){return 0===(0,l.Y)(e.item.items,e.activePath).length?(0,b.jsx)(K,{...e}):(0,b.jsx)(Y,{...e})}function K({item:e,...t}){if("string"!=typeof e.href)return null;const{type:n,collapsed:a,collapsible:i,items:s,linkUnlisted:o,...l}=e,r={type:"link",...l};return(0,b.jsx)(D,{item:r,...t})}function Y({item:e,onItemClick:t,activePath:n,level:s,index:r,...c}){const{items:d,label:u,collapsible:m,className:h,href:p}=e,{docs:{sidebar:{autoCollapseCategories:x}}}=(0,_.p)(),j=function(e){const t=(0,B.A)();return(0,a.useMemo)(()=>e.href&&!e.linkUnlisted?e.href:!t&&e.collapsible?(0,l.Nr)(e):void 0,[e,t])}(e),f=(0,l.w8)(e,n),g=(0,w.ys)(p,n),{collapsed:v,setCollapsed:C}=(0,L.u)({initialState:()=>!!m&&(!f&&e.collapsed)}),{expandedItem:A,setExpandedItem:k}=function(){const e=(0,a.useContext)(y);if(e===T)throw new N.dV("DocSidebarItemsExpandedStateProvider");return e}(),S=(e=!v)=>{k(e?null:r),C(e)};!function({isActive:e,collapsed:t,updateCollapsed:n,activePath:i}){const s=(0,N.ZC)(e),o=(0,N.ZC)(i);(0,a.useEffect)(()=>{(e&&!s||e&&s&&i!==o)&&t&&n(!1)},[e,s,t,n,i,o])}({isActive:f,collapsed:v,updateCollapsed:S,activePath:n}),(0,a.useEffect)(()=>{m&&null!=A&&A!==r&&x&&C(!0)},[m,A,r,C,x]);return(0,b.jsxs)("li",{className:(0,i.A)(o.G.docs.docSidebarItemCategory,o.G.docs.docSidebarItemCategoryLevel(s),"menu__list-item",{"menu__list-item--collapsed":v},h),children:[(0,b.jsxs)("div",{className:(0,i.A)("menu__list-item-collapsible",{"menu__list-item-collapsible--active":g}),children:[(0,b.jsx)(E.A,{className:(0,i.A)(W,"menu__link",{"menu__link--sublist":m,"menu__link--sublist-caret":!p&&m,"menu__link--active":f}),onClick:n=>{t?.(e),m&&(p?g?(n.preventDefault(),S()):S(!1):(n.preventDefault(),S()))},"aria-current":g?"page":void 0,role:m&&!p?"button":void 0,"aria-expanded":m&&!p?!v:void 0,href:m?j??"#":j,...c,children:(0,b.jsx)(U,{label:u})}),p&&m&&(0,b.jsx)(F,{collapsed:v,categoryLabel:u,onClick:e=>{e.preventDefault(),S()}})]}),(0,b.jsx)(L.N,{lazy:!0,as:"ul",className:"menu__list",collapsed:v,children:(0,b.jsx)(X,{items:d,tabIndex:v?-1:0,onItemClick:t,activePath:n,level:s+1})})]})}const Z="menuHtmlItem_L5pK";function z({item:e,level:t,index:n}){const{value:a,defaultStyle:s,className:l}=e;return(0,b.jsx)("li",{className:(0,i.A)(o.G.docs.docSidebarItemLink,o.G.docs.docSidebarItemLinkLevel(t),s&&[Z,"menu__list-item"],l),dangerouslySetInnerHTML:{__html:a}},n)}function O({item:e,...t}){switch(e.type){case"category":return(0,b.jsx)(q,{item:e,...t});case"html":return(0,b.jsx)(z,{item:e,...t});default:return(0,b.jsx)(D,{item:e,...t})}}function Q({items:e,...t}){const n=(0,l.Y)(e,t.activePath);return(0,b.jsx)(I,{children:n.map((e,n)=>(0,b.jsx)(O,{item:e,index:n,...t},n))})}const X=(0,a.memo)(Q),$="menu_OmRr",J="menuWithAnnouncementBar_Fh5i";function ee({path:e,sidebar:t,className:n}){const s=function(){const{isActive:e}=(0,S.M)(),[t,n]=(0,a.useState)(e);return(0,d.Mq)(({scrollY:t})=>{e&&n(0===t)},[e]),e&&t}();return(0,b.jsx)("nav",{"aria-label":(0,c.T)({id:"theme.docs.sidebar.navAriaLabel",message:"Docs sidebar",description:"The ARIA label for the sidebar navigation"}),className:(0,i.A)("menu thin-scrollbar",$,s&&J,n),children:(0,b.jsx)("ul",{className:(0,i.A)(o.G.docs.docSidebarMenu,"menu__list"),children:(0,b.jsx)(X,{items:t,activePath:e,level:1})})})}const te="sidebar_kOfH",ne="sidebarWithHideableNavbar_bW8i",ae="sidebarHidden_PP3U",ie="sidebarLogo_cS57";function se({path:e,sidebar:t,onCollapse:n,isHidden:a}){const{navbar:{hideOnScroll:s},docs:{sidebar:{hideable:o}}}=(0,_.p)();return(0,b.jsxs)("div",{className:(0,i.A)(te,s&&ne,a&&ae),children:[s&&(0,b.jsx)(g.A,{tabIndex:-1,className:ie}),(0,b.jsx)(ee,{path:e,sidebar:t}),o&&(0,b.jsx)(k,{onClick:n})]})}const oe=a.memo(se);var le=n(1487),re=n(3678);const ce=({sidebar:e,path:t})=>{const n=(0,re.M)();return(0,b.jsx)("ul",{className:(0,i.A)(o.G.docs.docSidebarMenu,"menu__list"),children:(0,b.jsx)(X,{items:e,activePath:t,onItemClick:e=>{"category"===e.type&&e.href&&n.toggle(),"link"===e.type&&n.toggle()},level:1})})};function de(e){return(0,b.jsx)(le.GX,{component:ce,props:e})}const ue=a.memo(de);function me(e){const t=(0,f.l)(),n="desktop"===t||"ssr"===t,a="mobile"===t;return(0,b.jsxs)(b.Fragment,{children:[n&&(0,b.jsx)(oe,{...e}),a&&(0,b.jsx)(ue,{...e})]})}const he="expandButton_j1a7",be="expandButtonIcon_R8eX";function pe({toggleSidebar:e}){return(0,b.jsx)("div",{className:he,title:(0,c.T)({id:"theme.docs.sidebar.expandButtonTitle",message:"Expand sidebar",description:"The ARIA label and title attribute for expand button of doc sidebar"}),"aria-label":(0,c.T)({id:"theme.docs.sidebar.expandButtonAriaLabel",message:"Expand sidebar",description:"The ARIA label and title attribute for expand button of doc sidebar"}),tabIndex:0,role:"button",onKeyDown:e,onClick:e,children:(0,b.jsx)(v,{className:be})})}const xe={docSidebarContainer:"docSidebarContainer_VgAC",docSidebarContainerHidden:"docSidebarContainerHidden_BZh7",sidebarViewport:"sidebarViewport_KhCA"};function je({children:e}){const t=(0,r.t)();return(0,b.jsx)(a.Fragment,{children:e},t?.name??"noSidebar")}function fe({sidebar:e,hiddenSidebarContainer:t,setHiddenSidebarContainer:n}){const{pathname:s}=(0,j.zy)(),[l,r]=(0,a.useState)(!1),c=(0,a.useCallback)(()=>{l&&r(!1),!l&&(0,x.O)()&&r(!0),n(e=>!e)},[n,l]);return(0,b.jsx)("aside",{className:(0,i.A)(o.G.docs.docSidebarContainer,xe.docSidebarContainer,t&&xe.docSidebarContainerHidden),onTransitionEnd:e=>{e.currentTarget.classList.contains(xe.docSidebarContainer)&&t&&r(!0)},children:(0,b.jsx)(je,{children:(0,b.jsxs)("div",{className:(0,i.A)(xe.sidebarViewport,l&&xe.sidebarViewportHidden),children:[(0,b.jsx)(me,{sidebar:e,path:s,onCollapse:c,isHidden:l}),l&&(0,b.jsx)(pe,{toggleSidebar:c})]})})})}const _e={docMainContainer:"docMainContainer_QTZx",docMainContainerEnhanced:"docMainContainerEnhanced_UIVK",docItemWrapperEnhanced:"docItemWrapperEnhanced_dlNE"};function ge({hiddenSidebarContainer:e,children:t}){const n=(0,r.t)();return(0,b.jsx)("main",{className:(0,i.A)(_e.docMainContainer,(e||!n)&&_e.docMainContainerEnhanced),children:(0,b.jsx)("div",{className:(0,i.A)("container padding-top--md padding-bottom--lg",_e.docItemWrapper,e&&_e.docItemWrapperEnhanced),children:t})})}const ve="docRoot_noFI",Ce="docsWrapper_VaWq";function Ae({children:e}){const t=(0,r.t)(),[n,i]=(0,a.useState)(!1);return(0,b.jsxs)("div",{className:Ce,children:[(0,b.jsx)(p,{}),(0,b.jsxs)("div",{className:ve,children:[t&&(0,b.jsx)(fe,{sidebar:t.items,hiddenSidebarContainer:n,setHiddenSidebarContainer:i}),(0,b.jsx)(ge,{hiddenSidebarContainer:n,children:e})]})]})}var ke=n(1030);function Se(e){const t=(0,l.B5)(e);if(!t)return(0,b.jsx)(ke.A,{});const{docElement:n,sidebarName:a,sidebarItems:c}=t;return(0,b.jsx)(s.e3,{className:(0,i.A)(o.G.page.docsDocPage),children:(0,b.jsx)(r.V,{name:a,items:c,children:(0,b.jsx)(Ae,{children:n})})})}},1030(e,t,n){n.d(t,{A:()=>l});n(758);var a=n(3526),i=n(2984),s=n(7699),o=n(6070);function l({className:e}){return(0,o.jsx)("main",{className:(0,a.A)("container margin-vert--xl",e),children:(0,o.jsx)("div",{className:"row",children:(0,o.jsxs)("div",{className:"col col--6 col--offset-3",children:[(0,o.jsx)(s.A,{as:"h1",className:"hero__title",children:(0,o.jsx)(i.A,{id:"theme.NotFound.title",description:"The title of the 404 page",children:"Page Not Found"})}),(0,o.jsx)("p",{children:(0,o.jsx)(i.A,{id:"theme.NotFound.p1",description:"The first paragraph of the 404 page",children:"We could not find what you were looking for."})}),(0,o.jsx)("p",{children:(0,o.jsx)(i.A,{id:"theme.NotFound.p2",description:"The 2nd paragraph of the 404 page",children:"Please contact the owner of the site that linked you to the original URL and let them know their link is broken."})})]})})})}}}]);
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
"use strict";(globalThis.webpackChunk_elliemae_pui_cli=globalThis.webpackChunk_elliemae_pui_cli||[]).push([[6264],{4992(e,t,i){i.r(t),i.d(t,{assets:()=>o,contentTitle:()=>r,default:()=>f,frontMatter:()=>l,metadata:()=>n,toc:()=>c});const n=JSON.parse('{"id":"api/variables/eslintFlatBaseConfig","title":"eslintFlatBaseConfig","description":"Flat ESLint config for non-React TypeScript libraries and services.","source":"@site/docs/api/variables/eslintFlatBaseConfig.md","sourceDirName":"api/variables","slug":"/api/variables/eslintFlatBaseConfig","permalink":"/cli/api/variables/eslintFlatBaseConfig","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-cli.git/docs/api/variables/eslintFlatBaseConfig.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"~~eslintConfig~~","permalink":"/cli/api/variables/eslintConfig"},"next":{"title":"eslintFlatBaseConfigStrict","permalink":"/cli/api/variables/eslintFlatBaseConfigStrict"}}');var a=i(6070),s=i(6607);const l={},r="eslintFlatBaseConfig",o={},c=[];function p(e){const t={code:"code",h1:"h1",header:"header",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.header,{children:(0,a.jsx)(t.h1,{id:"eslintflatbaseconfig",children:"eslintFlatBaseConfig"})}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-ts",children:"const eslintFlatBaseConfig: any = nonReactFlatConfigs;\n"})}),"\n",(0,a.jsx)(t.p,{children:"Flat ESLint config for non-React TypeScript libraries and services."})]})}function f(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(p,{...e})}):p(e)}},6607(e,t,i){i.d(t,{R:()=>l,x:()=>r});var n=i(758);const a={},s=n.createContext(a);function l(e){const t=n.useContext(s);return n.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:l(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]);
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
"use strict";(globalThis.webpackChunk_elliemae_pui_cli=globalThis.webpackChunk_elliemae_pui_cli||[]).push([[7613],{7033(e,n,s){s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>u,frontMatter:()=>i,metadata:()=>r,toc:()=>c});const r=JSON.parse('{"id":"api/variables/eslintConfig","title":"~~eslintConfig~~","description":"Type Declaration","source":"@site/docs/api/variables/eslintConfig.md","sourceDirName":"api/variables","slug":"/api/variables/eslintConfig","permalink":"/cli/api/variables/eslintConfig","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-cli.git/docs/api/variables/eslintConfig.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"~~eslintBaseConfig~~","permalink":"/cli/api/variables/eslintBaseConfig"},"next":{"title":"eslintFlatBaseConfig","permalink":"/cli/api/variables/eslintFlatBaseConfig"}}');var l=s(6070),a=s(6607);const i={},t="eslintConfig",o={},c=[{value:"Type Declaration",id:"type-declaration",level:2},{value:"<del>env</del>",id:"env",level:3},{value:"env.browser",id:"envbrowser",level:4},{value:"env.es2021",id:"enves2021",level:4},{value:"env.jest",id:"envjest",level:4},{value:"env.node",id:"envnode",level:4},{value:"<del>extends</del>",id:"extends",level:3},{value:"<del>ignorePatterns</del>",id:"ignorepatterns",level:3},{value:"<del>overrides</del>",id:"overrides",level:3},{value:"<del>parser</del>",id:"parser",level:3},{value:"<del>parserOptions</del>",id:"parseroptions",level:3},{value:"parserOptions.babelOptions",id:"parseroptionsbabeloptions",level:4},{value:"parserOptions.babelOptions.plugins",id:"parseroptionsbabeloptionsplugins",level:4},{value:"parserOptions.ecmaFeatures",id:"parseroptionsecmafeatures",level:4},{value:"parserOptions.ecmaFeatures.jsx",id:"parseroptionsecmafeaturesjsx",level:4},{value:"parserOptions.sourceType",id:"parseroptionssourcetype",level:4},{value:"<del>plugins</del>",id:"plugins",level:3},{value:"<del>rules</del>",id:"rules",level:3},{value:"rules.arrow-body-style",id:"rulesarrow-body-style",level:4},{value:"rules.class-methods-use-this",id:"rulesclass-methods-use-this",level:4},{value:"rules.complexity",id:"rulescomplexity",level:4},{value:"rules.eslint-comments/disable-enable-pair",id:"ruleseslint-commentsdisable-enable-pair",level:4},{value:"rules.import/extensions",id:"rulesimportextensions",level:4},{value:"rules.import/imports-first",id:"rulesimportimports-first",level:4},{value:"rules.import/newline-after-import",id:"rulesimportnewline-after-import",level:4},{value:"rules.import/no-dynamic-require",id:"rulesimportno-dynamic-require",level:4},{value:"rules.import/no-extraneous-dependencies",id:"rulesimportno-extraneous-dependencies",level:4},{value:"rules.import/no-named-as-default",id:"rulesimportno-named-as-default",level:4},{value:"rules.import/no-unresolved",id:"rulesimportno-unresolved",level:4},{value:"rules.import/no-webpack-loader-syntax",id:"rulesimportno-webpack-loader-syntax",level:4},{value:"rules.import/prefer-default-export",id:"rulesimportprefer-default-export",level:4},{value:"rules.indent",id:"rulesindent",level:4},{value:"rules.jsdoc/require-jsdoc",id:"rulesjsdocrequire-jsdoc",level:4},{value:"rules.jsx-a11y/aria-props",id:"rulesjsx-a11yaria-props",level:4},{value:"rules.jsx-a11y/heading-has-content",id:"rulesjsx-a11yheading-has-content",level:4},{value:"rules.jsx-a11y/label-has-associated-control",id:"rulesjsx-a11ylabel-has-associated-control",level:4},{value:"rules.jsx-a11y/label-has-for",id:"rulesjsx-a11ylabel-has-for",level:4},{value:"rules.jsx-a11y/mouse-events-have-key-events",id:"rulesjsx-a11ymouse-events-have-key-events",level:4},{value:"rules.jsx-a11y/role-has-required-aria-props",id:"rulesjsx-a11yrole-has-required-aria-props",level:4},{value:"rules.jsx-a11y/role-supports-aria-props",id:"rulesjsx-a11yrole-supports-aria-props",level:4},{value:"rules.max-depth",id:"rulesmax-depth",level:4},{value:"rules.max-len",id:"rulesmax-len",level:4},{value:"rules.max-lines",id:"rulesmax-lines",level:4},{value:"rules.max-lines-per-function",id:"rulesmax-lines-per-function",level:4},{value:"rules.max-nested-callbacks",id:"rulesmax-nested-callbacks",level:4},{value:"rules.max-params",id:"rulesmax-params",level:4},{value:"rules.max-statements",id:"rulesmax-statements",level:4},{value:"rules.newline-per-chained-call",id:"rulesnewline-per-chained-call",level:4},{value:"rules.no-confusing-arrow",id:"rulesno-confusing-arrow",level:4},{value:"rules.no-console",id:"rulesno-console",level:4},{value:"rules.no-param-reassign",id:"rulesno-param-reassign",level:4},{value:"rules.no-unused-vars",id:"rulesno-unused-vars",level:4},{value:"rules.no-use-before-define",id:"rulesno-use-before-define",level:4},{value:"rules.prefer-template",id:"rulesprefer-template",level:4},{value:"rules.prettier/prettier",id:"rulesprettierprettier",level:4},{value:"rules.react-hooks/rules-of-hooks",id:"rulesreact-hooksrules-of-hooks",level:4},{value:"rules.react/destructuring-assignment",id:"rulesreactdestructuring-assignment",level:4},{value:"rules.react/forbid-prop-types",id:"rulesreactforbid-prop-types",level:4},{value:"rules.react/function-component-definition",id:"rulesreactfunction-component-definition",level:4},{value:"rules.react/jsx-closing-tag-location",id:"rulesreactjsx-closing-tag-location",level:4},{value:"rules.react/jsx-filename-extension",id:"rulesreactjsx-filename-extension",level:4},{value:"rules.react/jsx-first-prop-new-line",id:"rulesreactjsx-first-prop-new-line",level:4},{value:"rules.react/jsx-no-target-blank",id:"rulesreactjsx-no-target-blank",level:4},{value:"rules.react/jsx-props-no-spreading",id:"rulesreactjsx-props-no-spreading",level:4},{value:"rules.react/jsx-uses-vars",id:"rulesreactjsx-uses-vars",level:4},{value:"rules.react/react-in-jsx-scope",id:"rulesreactreact-in-jsx-scope",level:4},{value:"rules.react/require-default-props",id:"rulesreactrequire-default-props",level:4},{value:"rules.react/require-extension",id:"rulesreactrequire-extension",level:4},{value:"rules.react/self-closing-comp",id:"rulesreactself-closing-comp",level:4},{value:"rules.react/sort-comp",id:"rulesreactsort-comp",level:4},{value:"rules.redux-saga/no-yield-in-race",id:"rulesredux-sagano-yield-in-race",level:4},{value:"rules.redux-saga/yield-effects",id:"rulesredux-sagayield-effects",level:4},{value:"rules.require-yield",id:"rulesrequire-yield",level:4},{value:"<del>settings</del>",id:"settings",level:3},{value:"settings.import/resolver",id:"settingsimportresolver",level:4},{value:"settings.import/resolver.node",id:"settingsimportresolvernode",level:4},{value:"settings.import/resolver.node.extensions",id:"settingsimportresolvernodeextensions",level:4},{value:"settings.jest",id:"settingsjest",level:4},{value:"settings.jest.version",id:"settingsjestversion",level:4},{value:"settings.react",id:"settingsreact",level:4},{value:"settings.react.version",id:"settingsreactversion",level:4},{value:"Deprecated",id:"deprecated",level:2}];function d(e){const n={code:"code",del:"del",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.header,{children:(0,l.jsx)(n.h1,{id:"eslintconfig",children:(0,l.jsx)(n.del,{children:"eslintConfig"})})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"eslintConfig: {\n env: {\n browser: boolean;\n es2021: boolean;\n jest: boolean;\n node: boolean;\n };\n extends: string[];\n ignorePatterns: string[];\n overrides: {\n files: string[];\n rules: {\n jest/valid-expect: string;\n };\n }[];\n parser: string;\n parserOptions: {\n babelOptions: {\n plugins: string[];\n };\n ecmaFeatures: {\n jsx: boolean;\n };\n sourceType: string;\n };\n plugins: string[];\n rules: {\n arrow-body-style: (string | number)[];\n class-methods-use-this: number;\n complexity: (\n | string\n | {\n max: number;\n })[];\n eslint-comments/disable-enable-pair: number;\n import/extensions: (\n | string\n | number\n | {\n js: string;\n json: string;\n })[];\n import/imports-first: number;\n import/newline-after-import: number;\n import/no-dynamic-require: number;\n import/no-extraneous-dependencies: number;\n import/no-named-as-default: number;\n import/no-unresolved: (\n | number\n | {\n caseSensitive: boolean;\n caseSensitiveStrict: boolean;\n })[];\n import/no-webpack-loader-syntax: number;\n import/prefer-default-export: number;\n indent: (\n | number\n | {\n SwitchCase: number;\n })[];\n jsdoc/require-jsdoc: number;\n jsx-a11y/aria-props: number;\n jsx-a11y/heading-has-content: number;\n jsx-a11y/label-has-associated-control: (\n | number\n | {\n controlComponents: string[];\n })[];\n jsx-a11y/label-has-for: number;\n jsx-a11y/mouse-events-have-key-events: number;\n jsx-a11y/role-has-required-aria-props: number;\n jsx-a11y/role-supports-aria-props: number;\n max-depth: (\n | string\n | {\n max: number;\n })[];\n max-len: number;\n max-lines: (\n | string\n | {\n max: number;\n skipComments: boolean;\n })[];\n max-lines-per-function: number;\n max-nested-callbacks: (\n | string\n | {\n max: number;\n })[];\n max-params: (\n | string\n | {\n max: number;\n })[];\n max-statements: (\n | string\n | {\n max: number;\n })[];\n newline-per-chained-call: number;\n no-confusing-arrow: number;\n no-console: number;\n no-param-reassign: (\n | string\n | {\n props: boolean;\n })[];\n no-unused-vars: number;\n no-use-before-define: number;\n prefer-template: number;\n prettier/prettier: (string | __module)[];\n react-hooks/rules-of-hooks: string;\n react/destructuring-assignment: number;\n react/forbid-prop-types: number;\n react/function-component-definition: (\n | number\n | {\n namedComponents: string;\n })[];\n react/jsx-closing-tag-location: number;\n react/jsx-filename-extension: (\n | number\n | {\n extensions: string[];\n })[];\n react/jsx-first-prop-new-line: (string | number)[];\n react/jsx-no-target-blank: number;\n react/jsx-props-no-spreading: number;\n react/jsx-uses-vars: number;\n react/react-in-jsx-scope: number;\n react/require-default-props: number;\n react/require-extension: number;\n react/self-closing-comp: number;\n react/sort-comp: number;\n redux-saga/no-yield-in-race: number;\n redux-saga/yield-effects: number;\n require-yield: number;\n };\n settings: {\n import/resolver: {\n node: {\n extensions: string[];\n };\n };\n jest: {\n version: number;\n };\n react: {\n version: string;\n };\n };\n};\n"})}),"\n",(0,l.jsx)(n.h2,{id:"type-declaration",children:"Type Declaration"}),"\n",(0,l.jsx)(n.h3,{id:"env",children:(0,l.jsx)(n.del,{children:"env"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"env: {\n browser: boolean;\n es2021: boolean;\n jest: boolean;\n node: boolean;\n};\n"})}),"\n",(0,l.jsx)(n.h4,{id:"envbrowser",children:"env.browser"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"browser: boolean = true;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"enves2021",children:"env.es2021"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"es2021: boolean = true;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"envjest",children:"env.jest"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"jest: boolean = true;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"envnode",children:"env.node"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"node: boolean = true;\n"})}),"\n",(0,l.jsx)(n.h3,{id:"extends",children:(0,l.jsx)(n.del,{children:"extends"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"extends: string[];\n"})}),"\n",(0,l.jsx)(n.h3,{id:"ignorepatterns",children:(0,l.jsx)(n.del,{children:"ignorePatterns"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"ignorePatterns: string[];\n"})}),"\n",(0,l.jsx)(n.h3,{id:"overrides",children:(0,l.jsx)(n.del,{children:"overrides"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"overrides: {\n files: string[];\n rules: {\n jest/valid-expect: string;\n };\n}[];\n"})}),"\n",(0,l.jsx)(n.h3,{id:"parser",children:(0,l.jsx)(n.del,{children:"parser"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:'parser: string = "@babel/eslint-parser";\n'})}),"\n",(0,l.jsx)(n.h3,{id:"parseroptions",children:(0,l.jsx)(n.del,{children:"parserOptions"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"parserOptions: {\n babelOptions: {\n plugins: string[];\n };\n ecmaFeatures: {\n jsx: boolean;\n };\n sourceType: string;\n};\n"})}),"\n",(0,l.jsx)(n.h4,{id:"parseroptionsbabeloptions",children:"parserOptions.babelOptions"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"babelOptions: {\n plugins: string[];\n};\n"})}),"\n",(0,l.jsx)(n.h4,{id:"parseroptionsbabeloptionsplugins",children:"parserOptions.babelOptions.plugins"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"plugins: string[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"parseroptionsecmafeatures",children:"parserOptions.ecmaFeatures"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"ecmaFeatures: {\n jsx: boolean;\n};\n"})}),"\n",(0,l.jsx)(n.h4,{id:"parseroptionsecmafeaturesjsx",children:"parserOptions.ecmaFeatures.jsx"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"jsx: boolean = true;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"parseroptionssourcetype",children:"parserOptions.sourceType"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:'sourceType: string = "module";\n'})}),"\n",(0,l.jsx)(n.h3,{id:"plugins",children:(0,l.jsx)(n.del,{children:"plugins"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"plugins: string[] = basePlugins;\n"})}),"\n",(0,l.jsx)(n.h3,{id:"rules",children:(0,l.jsx)(n.del,{children:"rules"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"rules: {\n arrow-body-style: (string | number)[];\n class-methods-use-this: number;\n complexity: (\n | string\n | {\n max: number;\n })[];\n eslint-comments/disable-enable-pair: number;\n import/extensions: (\n | string\n | number\n | {\n js: string;\n json: string;\n })[];\n import/imports-first: number;\n import/newline-after-import: number;\n import/no-dynamic-require: number;\n import/no-extraneous-dependencies: number;\n import/no-named-as-default: number;\n import/no-unresolved: (\n | number\n | {\n caseSensitive: boolean;\n caseSensitiveStrict: boolean;\n })[];\n import/no-webpack-loader-syntax: number;\n import/prefer-default-export: number;\n indent: (\n | number\n | {\n SwitchCase: number;\n })[];\n jsdoc/require-jsdoc: number;\n jsx-a11y/aria-props: number;\n jsx-a11y/heading-has-content: number;\n jsx-a11y/label-has-associated-control: (\n | number\n | {\n controlComponents: string[];\n })[];\n jsx-a11y/label-has-for: number;\n jsx-a11y/mouse-events-have-key-events: number;\n jsx-a11y/role-has-required-aria-props: number;\n jsx-a11y/role-supports-aria-props: number;\n max-depth: (\n | string\n | {\n max: number;\n })[];\n max-len: number;\n max-lines: (\n | string\n | {\n max: number;\n skipComments: boolean;\n })[];\n max-lines-per-function: number;\n max-nested-callbacks: (\n | string\n | {\n max: number;\n })[];\n max-params: (\n | string\n | {\n max: number;\n })[];\n max-statements: (\n | string\n | {\n max: number;\n })[];\n newline-per-chained-call: number;\n no-confusing-arrow: number;\n no-console: number;\n no-param-reassign: (\n | string\n | {\n props: boolean;\n })[];\n no-unused-vars: number;\n no-use-before-define: number;\n prefer-template: number;\n prettier/prettier: (string | __module)[];\n react-hooks/rules-of-hooks: string;\n react/destructuring-assignment: number;\n react/forbid-prop-types: number;\n react/function-component-definition: (\n | number\n | {\n namedComponents: string;\n })[];\n react/jsx-closing-tag-location: number;\n react/jsx-filename-extension: (\n | number\n | {\n extensions: string[];\n })[];\n react/jsx-first-prop-new-line: (string | number)[];\n react/jsx-no-target-blank: number;\n react/jsx-props-no-spreading: number;\n react/jsx-uses-vars: number;\n react/react-in-jsx-scope: number;\n react/require-default-props: number;\n react/require-extension: number;\n react/self-closing-comp: number;\n react/sort-comp: number;\n redux-saga/no-yield-in-race: number;\n redux-saga/yield-effects: number;\n require-yield: number;\n};\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesarrow-body-style",children:"rules.arrow-body-style"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"arrow-body-style: (string | number)[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesclass-methods-use-this",children:"rules.class-methods-use-this"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"class-methods-use-this: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulescomplexity",children:"rules.complexity"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"complexity: (\n | string\n | {\n max: number;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"ruleseslint-commentsdisable-enable-pair",children:"rules.eslint-comments/disable-enable-pair"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"eslint-comments/disable-enable-pair: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesimportextensions",children:"rules.import/extensions"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import/extensions: (\n | string\n | number\n | {\n js: string;\n json: string;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesimportimports-first",children:"rules.import/imports-first"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import/imports-first: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesimportnewline-after-import",children:"rules.import/newline-after-import"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import/newline-after-import: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesimportno-dynamic-require",children:"rules.import/no-dynamic-require"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import/no-dynamic-require: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesimportno-extraneous-dependencies",children:"rules.import/no-extraneous-dependencies"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import/no-extraneous-dependencies: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesimportno-named-as-default",children:"rules.import/no-named-as-default"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import/no-named-as-default: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesimportno-unresolved",children:"rules.import/no-unresolved"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import/no-unresolved: (\n | number\n | {\n caseSensitive: boolean;\n caseSensitiveStrict: boolean;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesimportno-webpack-loader-syntax",children:"rules.import/no-webpack-loader-syntax"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import/no-webpack-loader-syntax: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesimportprefer-default-export",children:"rules.import/prefer-default-export"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import/prefer-default-export: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesindent",children:"rules.indent"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"indent: (\n | number\n | {\n SwitchCase: number;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesjsdocrequire-jsdoc",children:"rules.jsdoc/require-jsdoc"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"jsdoc/require-jsdoc: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesjsx-a11yaria-props",children:"rules.jsx-a11y/aria-props"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"jsx-a11y/aria-props: number = 2;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesjsx-a11yheading-has-content",children:"rules.jsx-a11y/heading-has-content"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"jsx-a11y/heading-has-content: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesjsx-a11ylabel-has-associated-control",children:"rules.jsx-a11y/label-has-associated-control"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"jsx-a11y/label-has-associated-control: (\n | number\n | {\n controlComponents: string[];\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesjsx-a11ylabel-has-for",children:"rules.jsx-a11y/label-has-for"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"jsx-a11y/label-has-for: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesjsx-a11ymouse-events-have-key-events",children:"rules.jsx-a11y/mouse-events-have-key-events"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"jsx-a11y/mouse-events-have-key-events: number = 2;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesjsx-a11yrole-has-required-aria-props",children:"rules.jsx-a11y/role-has-required-aria-props"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"jsx-a11y/role-has-required-aria-props: number = 2;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesjsx-a11yrole-supports-aria-props",children:"rules.jsx-a11y/role-supports-aria-props"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"jsx-a11y/role-supports-aria-props: number = 2;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesmax-depth",children:"rules.max-depth"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"max-depth: (\n | string\n | {\n max: number;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesmax-len",children:"rules.max-len"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"max-len: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesmax-lines",children:"rules.max-lines"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"max-lines: (\n | string\n | {\n max: number;\n skipComments: boolean;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesmax-lines-per-function",children:"rules.max-lines-per-function"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"max-lines-per-function: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesmax-nested-callbacks",children:"rules.max-nested-callbacks"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"max-nested-callbacks: (\n | string\n | {\n max: number;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesmax-params",children:"rules.max-params"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"max-params: (\n | string\n | {\n max: number;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesmax-statements",children:"rules.max-statements"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"max-statements: (\n | string\n | {\n max: number;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesnewline-per-chained-call",children:"rules.newline-per-chained-call"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"newline-per-chained-call: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesno-confusing-arrow",children:"rules.no-confusing-arrow"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"no-confusing-arrow: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesno-console",children:"rules.no-console"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"no-console: number = 1;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesno-param-reassign",children:"rules.no-param-reassign"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"no-param-reassign: (\n | string\n | {\n props: boolean;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesno-unused-vars",children:"rules.no-unused-vars"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"no-unused-vars: number = 2;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesno-use-before-define",children:"rules.no-use-before-define"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"no-use-before-define: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesprefer-template",children:"rules.prefer-template"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"prefer-template: number = 2;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesprettierprettier",children:"rules.prettier/prettier"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"prettier/prettier: (string | __module)[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesreact-hooksrules-of-hooks",children:"rules.react-hooks/rules-of-hooks"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:'react-hooks/rules-of-hooks: string = "error";\n'})}),"\n",(0,l.jsx)(n.h4,{id:"rulesreactdestructuring-assignment",children:"rules.react/destructuring-assignment"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react/destructuring-assignment: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesreactforbid-prop-types",children:"rules.react/forbid-prop-types"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react/forbid-prop-types: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesreactfunction-component-definition",children:"rules.react/function-component-definition"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react/function-component-definition: (\n | number\n | {\n namedComponents: string;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesreactjsx-closing-tag-location",children:"rules.react/jsx-closing-tag-location"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react/jsx-closing-tag-location: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesreactjsx-filename-extension",children:"rules.react/jsx-filename-extension"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react/jsx-filename-extension: (\n | number\n | {\n extensions: string[];\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesreactjsx-first-prop-new-line",children:"rules.react/jsx-first-prop-new-line"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react/jsx-first-prop-new-line: (string | number)[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesreactjsx-no-target-blank",children:"rules.react/jsx-no-target-blank"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react/jsx-no-target-blank: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesreactjsx-props-no-spreading",children:"rules.react/jsx-props-no-spreading"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react/jsx-props-no-spreading: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesreactjsx-uses-vars",children:"rules.react/jsx-uses-vars"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react/jsx-uses-vars: number = 2;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesreactreact-in-jsx-scope",children:"rules.react/react-in-jsx-scope"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react/react-in-jsx-scope: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesreactrequire-default-props",children:"rules.react/require-default-props"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react/require-default-props: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesreactrequire-extension",children:"rules.react/require-extension"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react/require-extension: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesreactself-closing-comp",children:"rules.react/self-closing-comp"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react/self-closing-comp: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesreactsort-comp",children:"rules.react/sort-comp"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react/sort-comp: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesredux-sagano-yield-in-race",children:"rules.redux-saga/no-yield-in-race"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"redux-saga/no-yield-in-race: number = 2;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesredux-sagayield-effects",children:"rules.redux-saga/yield-effects"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"redux-saga/yield-effects: number = 2;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesrequire-yield",children:"rules.require-yield"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"require-yield: number = 0;\n"})}),"\n",(0,l.jsx)(n.h3,{id:"settings",children:(0,l.jsx)(n.del,{children:"settings"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"settings: {\n import/resolver: {\n node: {\n extensions: string[];\n };\n };\n jest: {\n version: number;\n };\n react: {\n version: string;\n };\n};\n"})}),"\n",(0,l.jsx)(n.h4,{id:"settingsimportresolver",children:"settings.import/resolver"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import/resolver: {\n node: {\n extensions: string[];\n };\n};\n"})}),"\n",(0,l.jsx)(n.h4,{id:"settingsimportresolvernode",children:"settings.import/resolver.node"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"node: {\n extensions: string[];\n};\n"})}),"\n",(0,l.jsx)(n.h4,{id:"settingsimportresolvernodeextensions",children:"settings.import/resolver.node.extensions"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"extensions: string[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"settingsjest",children:"settings.jest"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"jest: {\n version: number;\n};\n"})}),"\n",(0,l.jsx)(n.h4,{id:"settingsjestversion",children:"settings.jest.version"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"version: number = 28;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"settingsreact",children:"settings.react"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react: {\n version: string;\n};\n"})}),"\n",(0,l.jsx)(n.h4,{id:"settingsreactversion",children:"settings.react.version"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:'version: string = "detect";\n'})}),"\n",(0,l.jsx)(n.h2,{id:"deprecated",children:"Deprecated"}),"\n",(0,l.jsx)(n.p,{children:"Use eslintFlatConfig in eslint.config.mjs"})]})}function u(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(d,{...e})}):d(e)}},6607(e,n,s){s.d(n,{R:()=>i,x:()=>t});var r=s(758);const l={},a=r.createContext(l);function i(e){const n=r.useContext(a);return r.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:i(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]);
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
"use strict";(globalThis.webpackChunk_elliemae_pui_cli=globalThis.webpackChunk_elliemae_pui_cli||[]).push([[3361],{2489(e,n,i){i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>a});const s=JSON.parse('{"id":"index","title":"PUI CLI Documentation","description":"Welcome to the ICE MT UI Platform CLI documentation. This CLI tool provides a comprehensive set of commands for building, testing, and maintaining UI applications and libraries.","source":"@site/docs/index.md","sourceDirName":".","slug":"/","permalink":"/cli/","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-cli.git/docs/index.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"ESLint rules migration guide (legacy \u2192 ESLint 10 flat config)","permalink":"/cli/eslint-rules-migration"},"next":{"title":"pui-cli 9 migration guide","permalink":"/cli/pui-cli-9-migration"}}');var t=i(6070),l=i(6607);const r={},o="PUI CLI Documentation",c={},a=[{value:"Quick Links",id:"quick-links",level:2},{value:"Features",id:"features",level:2},{value:"Getting Started",id:"getting-started",level:2},{value:"Prerequisites",id:"prerequisites",level:3},{value:"Installation",id:"installation",level:3},{value:"For New Projects",id:"for-new-projects",level:4},{value:"Quick Start",id:"quick-start",level:3},{value:"Setting Up a New Application",id:"setting-up-a-new-application",level:4},{value:"Project Structure",id:"project-structure",level:2},{value:"Application Structure",id:"application-structure",level:3},{value:"Library Structure",id:"library-structure",level:3},{value:"Configuration Files",id:"configuration-files",level:2},{value:"Prettier Configuration",id:"prettier-configuration",level:3},{value:"Stylelint Configuration",id:"stylelint-configuration",level:3},{value:"Commitlint Configuration",id:"commitlint-configuration",level:3},{value:"Lint-staged Configuration",id:"lint-staged-configuration",level:3},{value:"Babel Configuration (Optional)",id:"babel-configuration-optional",level:3},{value:"Git Hooks Setup",id:"git-hooks-setup",level:2},{value:"Additional Configuration Files",id:"additional-configuration-files",level:2},{value:"Jest Configuration",id:"jest-configuration",level:3},{value:"Environment Variables",id:"environment-variables",level:2},{value:"Running Your First Build",id:"running-your-first-build",level:2},{value:"Start Development Server",id:"start-development-server",level:3},{value:"Build for Production",id:"build-for-production",level:3},{value:"Run Tests",id:"run-tests",level:3},{value:"Linting and Type Checking",id:"linting-and-type-checking",level:3},{value:"Storybook",id:"storybook",level:3},{value:"Next Steps",id:"next-steps",level:2},{value:"Troubleshooting",id:"troubleshooting",level:2},{value:"Common Issues",id:"common-issues",level:3},{value:"Getting Help",id:"getting-help",level:2}];function d(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,l.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"pui-cli-documentation",children:"PUI CLI Documentation"})}),"\n",(0,t.jsx)(n.p,{children:"Welcome to the ICE MT UI Platform CLI documentation. This CLI tool provides a comprehensive set of commands for building, testing, and maintaining UI applications and libraries."}),"\n",(0,t.jsx)(n.h2,{id:"quick-links",children:"Quick Links"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://git.elliemae.io/platform-ui/pui-cli",children:"GitHub Repository"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://jenkinsbuild.elliemae.cloud/job/UIPlatform/job/pui-cli/job/master",children:"Build Job"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://sonarqube.jenkins.elliemae.cloud/overview?id=elliemae.pui.cli-master",children:"SonarQube Report"})}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.a,{href:"/cli/usage-guide",children:"Usage Guide"})})," - Detailed command reference and examples"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.a,{href:"/cli/pui-cli-9-migration",children:"pui-cli 9 Migration Guide"})})," - Node 24, pnpm 11, ESLint 10 upgrade path"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.a,{href:"/cli/eslint-rules-migration",children:"ESLint Rules Migration"})})," - Legacy ESLint 8 \u2192 flat config rule comparison"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.a,{href:"./api/",children:"API Documentation"})})," - Generated API docs from source code"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.a,{href:"/cli/ssl-certificate-setup",children:"SSL Certificate Setup"})})," - HTTPS certificate configuration"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"features",children:"Features"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["\ud83d\ude80 ",(0,t.jsx)(n.strong,{children:"Modern Build Tools"})," - Webpack and Vite integration"]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83e\uddea ",(0,t.jsx)(n.strong,{children:"Testing"})," - Jest and Vitest support with coverage"]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83c\udfa8 ",(0,t.jsx)(n.strong,{children:"Linting"})," - ESLint, Prettier, and Stylelint configurations"]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83d\udcdd ",(0,t.jsx)(n.strong,{children:"TypeScript"})," - Full TypeScript support"]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83d\udcda ",(0,t.jsx)(n.strong,{children:"Storybook"})," - Component development and documentation"]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83d\udd27 ",(0,t.jsx)(n.strong,{children:"Development Server"})," - Hot module replacement"]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83d\udce6 ",(0,t.jsx)(n.strong,{children:"Library Support"})," - Build both applications and libraries"]}),"\n",(0,t.jsxs)(n.li,{children:["\ud83c\udfaf ",(0,t.jsx)(n.strong,{children:"Monorepo Support"})," - Workspace version management"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"getting-started",children:"Getting Started"}),"\n",(0,t.jsxs)(n.p,{children:["This guide will help you get started with ",(0,t.jsx)(n.code,{children:"@elliemae/pui-cli"}),", a command-line interface tool for building and managing UI applications and libraries."]}),"\n",(0,t.jsx)(n.h3,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,t.jsx)(n.p,{children:"Before you begin, ensure you have the following installed:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Node.js"}),": Version 20"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"pnpm"}),": Version 8 (recommended package manager)"]}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"installation",children:"Installation"}),"\n",(0,t.jsx)(n.h4,{id:"for-new-projects",children:"For New Projects"}),"\n",(0,t.jsx)(n.p,{children:"Install the CLI as a development dependency in your project:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"pnpm add -D @elliemae/pui-cli\n"})}),"\n",(0,t.jsx)(n.h3,{id:"quick-start",children:"Quick Start"}),"\n",(0,t.jsx)(n.h4,{id:"setting-up-a-new-application",children:"Setting Up a New Application"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Create a package.json"})," if you don't have one:"]}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"pnpm init\n"})}),"\n",(0,t.jsxs)(n.ol,{start:"2",children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Install pui-cli"}),":"]}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"pnpm add -D @elliemae/pui-cli\n"})}),"\n",(0,t.jsxs)(n.ol,{start:"3",children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Add scripts to your package.json"}),":"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"For applications:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-json",children:'{\n "scripts": {\n "start": "pui-cli start",\n "start:prod": "pui-cli start -p",\n "build": "pui-cli build",\n "test": "pui-cli test",\n "vitest": "pui-cli vitest",\n "test:fix": "pui-cli test -f",\n "test:debug": "pui-cli test --debug",\n "lint": "pui-cli lint",\n "lint:fix": "pui-cli lint --fix",\n "lint:staged": "lint-staged",\n "tscheck": "pui-cli tscheck --files",\n "storybook": "pui-cli storybook",\n "storybook:docs": "pui-cli storybook --docs",\n "storybook:build": "pui-cli storybook -b",\n "gendoc": "pui-cli gendoc"\n }\n}\n'})}),"\n",(0,t.jsx)(n.p,{children:"For libraries:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-json",children:'{\n "scripts": {\n "build": "pui-cli pack -p",\n "build:dev": "pui-cli pack",\n "test": "pui-cli test",\n "test:fix": "pui-cli test -f",\n "lint": "pui-cli lint",\n "lint:fix": "pui-cli lint --fix",\n "tscheck": "pui-cli tscheck --files"\n }\n}\n'})}),"\n",(0,t.jsxs)(n.ol,{start:"4",children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Create a TypeScript configuration"})," (",(0,t.jsx)(n.code,{children:"tsconfig.json"}),"):"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"For applications:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-json",children:'{\n "extends": "@elliemae/pui-cli/app.tsconfig.json",\n "compilerOptions": {\n "outDir": "dist/types",\n "baseUrl": ".",\n "paths": {}\n },\n "include": [\n "app/**/*",\n "wdio.config.mjs",\n "vitest.config.ts",\n "docusaurus.config.ts"\n ],\n "exclude": ["node_modules", "**/*.spec.ts"]\n}\n'})}),"\n",(0,t.jsx)(n.p,{children:"For libraries:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-json",children:'{\n "extends": "@elliemae/pui-cli/library.tsconfig.json",\n "compilerOptions": {\n "outDir": "dist/types",\n "declarationDir": "dist/types",\n "baseUrl": "."\n },\n "include": ["lib/**/*", "./docusaurus.config.ts"],\n "exclude": ["node_modules"]\n}\n'})}),"\n",(0,t.jsxs)(n.ol,{start:"5",children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Create your source structure"}),":"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"For applications:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"your-project/\n\u251c\u2500\u2500 app/\n\u2502 \u251c\u2500\u2500 index.tsx # Entry point\n\u2502 \u251c\u2500\u2500 route/ # Routes\n\u2502 \u251c\u2500\u2500 view/ # Components\n\u2502 \u251c\u2500\u2500 data/ # Redux slices\n\u2502 \u251c\u2500\u2500 api/ # RTK Query APIs\n\u2502 \u251c\u2500\u2500 sideeffect/ # Redux Sagas\n\u2502 \u251c\u2500\u2500 utils/ # Utilities\n\u2502 \u2514\u2500\u2500 app.config.json # App configuration\n\u251c\u2500\u2500 public/ # Static assets\n\u251c\u2500\u2500 package.json\n\u2514\u2500\u2500 tsconfig.json\n"})}),"\n",(0,t.jsx)(n.p,{children:"For libraries:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"your-project/\n\u251c\u2500\u2500 lib/\n\u2502 \u251c\u2500\u2500 index.ts # Entry point\n\u2502 \u251c\u2500\u2500 components/ # Components\n\u2502 \u251c\u2500\u2500 utils/ # Utilities\n\u2502 \u2514\u2500\u2500 __tests__/ # Tests\n\u251c\u2500\u2500 stories/ # Storybook stories (optional)\n\u251c\u2500\u2500 package.json\n\u2514\u2500\u2500 tsconfig.json\n"})}),"\n",(0,t.jsx)(n.h2,{id:"project-structure",children:"Project Structure"}),"\n",(0,t.jsx)(n.h3,{id:"application-structure",children:"Application Structure"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"your-app/\n\u251c\u2500\u2500 app/ # Application source code\n\u2502 \u251c\u2500\u2500 index.tsx # Entry point\n\u2502 \u251c\u2500\u2500 route/ # Route definitions\n\u2502 \u251c\u2500\u2500 view/ # UI components\n\u2502 \u251c\u2500\u2500 data/ # Redux slices (state)\n\u2502 \u251c\u2500\u2500 api/ # RTK Query API definitions\n\u2502 \u251c\u2500\u2500 sideeffect/ # Redux Sagas\n\u2502 \u251c\u2500\u2500 utils/ # Utility functions\n\u2502 \u251c\u2500\u2500 tests/ # Test files\n\u2502 \u2514\u2500\u2500 app.config.json # App configuration\n\u251c\u2500\u2500 public/ # Static assets\n\u251c\u2500\u2500 e2e/ # E2E tests (optional)\n\u251c\u2500\u2500 docs/ # Docusaurus docs (optional)\n\u251c\u2500\u2500 package.json\n\u2514\u2500\u2500 tsconfig.json\n"})}),"\n",(0,t.jsx)(n.h3,{id:"library-structure",children:"Library Structure"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"your-library/\n\u251c\u2500\u2500 lib/ # Library source code\n\u2502 \u251c\u2500\u2500 index.ts # Entry point\n\u2502 \u251c\u2500\u2500 components/ # Components\n\u2502 \u2514\u2500\u2500 __tests__/ # Test files\n\u251c\u2500\u2500 stories/ # Storybook stories\n\u251c\u2500\u2500 package.json\n\u2514\u2500\u2500 tsconfig.json\n"})}),"\n",(0,t.jsx)(n.h2,{id:"configuration-files",children:"Configuration Files"}),"\n",(0,t.jsx)(n.h3,{id:"prettier-configuration",children:"Prettier Configuration"}),"\n",(0,t.jsxs)(n.p,{children:["Create ",(0,t.jsx)(n.code,{children:"prettier.config.cjs"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"const { prettierConfig } = require('@elliemae/pui-cli');\nmodule.exports = prettierConfig;\n"})}),"\n",(0,t.jsx)(n.h3,{id:"stylelint-configuration",children:"Stylelint Configuration"}),"\n",(0,t.jsxs)(n.p,{children:["Create ",(0,t.jsx)(n.code,{children:"stylelint.config.mjs"})," (recommended) or ",(0,t.jsx)(n.code,{children:"stylelint.config.cjs"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"// stylelint.config.mjs\nimport { stylelintConfig } from '@elliemae/pui-cli/stylelint';\n\nexport default stylelintConfig;\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"// stylelint.config.cjs\nconst { stylelintConfig } = require('@elliemae/pui-cli');\nmodule.exports = stylelintConfig;\n"})}),"\n",(0,t.jsxs)(n.p,{children:["See ",(0,t.jsx)(n.a,{href:"/cli/stylelint-migration",children:"Stylelint migration guide"})," when upgrading from pui-cli 8."]}),"\n",(0,t.jsx)(n.h3,{id:"commitlint-configuration",children:"Commitlint Configuration"}),"\n",(0,t.jsxs)(n.p,{children:["Create ",(0,t.jsx)(n.code,{children:"commitlint.config.cjs"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"const { commitlintConfig } = require('@elliemae/pui-cli');\nmodule.exports = commitlintConfig;\n"})}),"\n",(0,t.jsx)(n.h3,{id:"lint-staged-configuration",children:"Lint-staged Configuration"}),"\n",(0,t.jsxs)(n.p,{children:["Create ",(0,t.jsx)(n.code,{children:"lint-staged.config.mjs"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"import { lintStagedConfig } from '@elliemae/pui-cli';\nexport default lintStagedConfig;\n"})}),"\n",(0,t.jsx)(n.h3,{id:"babel-configuration-optional",children:"Babel Configuration (Optional)"}),"\n",(0,t.jsxs)(n.p,{children:["Create ",(0,t.jsx)(n.code,{children:"babel.config.cjs"})," for custom Babel configuration:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"const { babelConfig } = require('@elliemae/pui-cli');\nmodule.exports = babelConfig;\n"})}),"\n",(0,t.jsx)(n.h2,{id:"git-hooks-setup",children:"Git Hooks Setup"}),"\n",(0,t.jsx)(n.p,{children:"To enable pre-commit hooks with Husky:"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Install Husky"}),":"]}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"pnpm add -D husky\nnpx husky init\n"})}),"\n",(0,t.jsxs)(n.ol,{start:"2",children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsxs)(n.strong,{children:["Create ",(0,t.jsx)(n.code,{children:".husky/pre-commit"})]}),":"]}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"pnpm -s dlx lint-staged\n"})}),"\n",(0,t.jsxs)(n.ol,{start:"3",children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsxs)(n.strong,{children:["Create ",(0,t.jsx)(n.code,{children:".husky/commit-msg"})]})," (optional, for commitlint):"]}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"pnpm exec commitlint --edit $1\n"})}),"\n",(0,t.jsx)(n.h2,{id:"additional-configuration-files",children:"Additional Configuration Files"}),"\n",(0,t.jsx)(n.h3,{id:"jest-configuration",children:"Jest Configuration"}),"\n",(0,t.jsxs)(n.p,{children:["For custom Jest configuration, create ",(0,t.jsx)(n.code,{children:"jest.config.cjs"}),":"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-javascript",children:"const { jestConfig } = require('@elliemae/pui-cli');\nmodule.exports = jestConfig;\n"})}),"\n",(0,t.jsx)(n.h2,{id:"environment-variables",children:"Environment Variables"}),"\n",(0,t.jsxs)(n.p,{children:["Create a ",(0,t.jsx)(n.code,{children:".env"})," file in your project root for environment-specific configuration:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-env",children:"PORT=3000\nNODE_ENV=development\n"})}),"\n",(0,t.jsx)(n.h2,{id:"running-your-first-build",children:"Running Your First Build"}),"\n",(0,t.jsx)(n.h3,{id:"start-development-server",children:"Start Development Server"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"# Start development server\npnpm start\n\n# Start with production mode\npnpm start:prod\n# or\npui-cli start -p\n"})}),"\n",(0,t.jsx)(n.p,{children:"This will:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"Start webpack dev server"}),"\n",(0,t.jsx)(n.li,{children:"Enable hot module replacement"}),"\n",(0,t.jsxs)(n.li,{children:["Serve your application (default: ",(0,t.jsx)(n.a,{href:"http://localhost:3000",children:"http://localhost:3000"}),")"]}),"\n",(0,t.jsx)(n.li,{children:"Watch for file changes"}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"build-for-production",children:"Build for Production"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"# Build application\npnpm build\n\n# Build library\npui-cli pack -p\n\n# Build library for development (no minification)\npui-cli pack\n"})}),"\n",(0,t.jsx)(n.p,{children:"This will:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"Create an optimized production build"}),"\n",(0,t.jsxs)(n.li,{children:["Output files to the ",(0,t.jsx)(n.code,{children:"dist/"})," or ",(0,t.jsx)(n.code,{children:"build/"})," directory"]}),"\n",(0,t.jsx)(n.li,{children:"Generate source maps"}),"\n",(0,t.jsx)(n.li,{children:"Minify and bundle your code"}),"\n",(0,t.jsx)(n.li,{children:"For libraries: Generate ESM, CJS, and type declarations"}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"run-tests",children:"Run Tests"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"# Run Jest tests\npnpm test\n\n# Run tests with auto-fix\npnpm test:fix\n\n# Debug tests\npnpm test:debug\n\n# Watch mode\npnpm test:watch\n"})}),"\n",(0,t.jsx)(n.h3,{id:"linting-and-type-checking",children:"Linting and Type Checking"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"# Lint code\npnpm lint\n\n# Auto-fix lint issues\npnpm lint:fix\n\n# Type check\npnpm tscheck\n\n# Lint staged files only\npnpm lint:staged\n"})}),"\n",(0,t.jsx)(n.h3,{id:"storybook",children:"Storybook"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"# Run Storybook dev server\npnpm storybook\n\n# Run with docs mode\npnpm storybook:docs\n\n# Build static Storybook\npnpm storybook:build\n"})}),"\n",(0,t.jsx)(n.h2,{id:"next-steps",children:"Next Steps"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Read the ",(0,t.jsx)(n.a,{href:"/cli/usage-guide",children:"Usage Guide"})," for detailed command documentation"]}),"\n",(0,t.jsxs)(n.li,{children:["Check out the ",(0,t.jsx)(n.a,{href:"./api/",children:"API Documentation"})," for library exports"]}),"\n",(0,t.jsxs)(n.li,{children:["Review the ",(0,t.jsx)(n.a,{href:"https://git.elliemae.io/platform-ui/pui-cli#migration-guide",children:"Migration Guide"})," if upgrading from an older version"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,t.jsx)(n.h3,{id:"common-issues",children:"Common Issues"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Port already in use:"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"# Change the port in your .env file\nPORT=3001\n"})}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Module not found errors:"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"# Clear node_modules and reinstall\nrm -rf node_modules\npnpm install\n"})}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Build fails with TypeScript errors:"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"# Run type checking separately to see detailed errors\npnpm tscheck\n"})}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"HTTPS certificate warnings:"})}),"\n",(0,t.jsx)(n.p,{children:'If you see "Not Secure" or certificate warnings when using HTTPS in development:'}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["See the ",(0,t.jsx)(n.a,{href:"/cli/ssl-certificate-setup",children:"SSL Certificate Setup Guide"})," for detailed instructions"]}),"\n",(0,t.jsx)(n.li,{children:"You need to trust the self-signed CA certificate on your system"}),"\n",(0,t.jsx)(n.li,{children:"Platform-specific instructions available for macOS, Windows, and Firefox"}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"getting-help",children:"Getting Help"}),"\n",(0,t.jsx)(n.p,{children:"If you encounter issues:"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["Review the documentation in the ",(0,t.jsx)(n.code,{children:"docs/"})," folder"]}),"\n",(0,t.jsx)(n.li,{children:"Reach out to the ui-platform teams channel"}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},6607(e,n,i){i.d(n,{R:()=>r,x:()=>o});var s=i(758);const t={},l=s.createContext(t);function r(e){const n=s.useContext(l);return s.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),s.createElement(l.Provider,{value:n},e.children)}}}]);
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
"use strict";(globalThis.webpackChunk_elliemae_pui_cli=globalThis.webpackChunk_elliemae_pui_cli||[]).push([[1724],{2046(e,n,s){s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>u,frontMatter:()=>a,metadata:()=>r,toc:()=>d});const r=JSON.parse('{"id":"api/variables/eslintBaseConfig","title":"~~eslintBaseConfig~~","description":"Type Declaration","source":"@site/docs/api/variables/eslintBaseConfig.md","sourceDirName":"api/variables","slug":"/api/variables/eslintBaseConfig","permalink":"/cli/api/variables/eslintBaseConfig","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-cli.git/docs/api/variables/eslintBaseConfig.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"commitlintConfig","permalink":"/cli/api/variables/commitlintConfig"},"next":{"title":"~~eslintConfig~~","permalink":"/cli/api/variables/eslintConfig"}}');var l=s(6070),i=s(6607);const a={},t="eslintBaseConfig",o={},d=[{value:"Type Declaration",id:"type-declaration",level:2},{value:"<del>env</del>",id:"env",level:3},{value:"env.browser",id:"envbrowser",level:4},{value:"env.es2021",id:"enves2021",level:4},{value:"env.jest",id:"envjest",level:4},{value:"env.node",id:"envnode",level:4},{value:"<del>extends</del>",id:"extends",level:3},{value:"<del>ignorePatterns</del>",id:"ignorepatterns",level:3},{value:"<del>overrides</del>",id:"overrides",level:3},{value:"<del>parser</del>",id:"parser",level:3},{value:"<del>parserOptions</del>",id:"parseroptions",level:3},{value:"parserOptions.babelOptions",id:"parseroptionsbabeloptions",level:4},{value:"parserOptions.babelOptions.plugins",id:"parseroptionsbabeloptionsplugins",level:4},{value:"parserOptions.ecmaFeatures",id:"parseroptionsecmafeatures",level:4},{value:"parserOptions.ecmaFeatures.jsx",id:"parseroptionsecmafeaturesjsx",level:4},{value:"parserOptions.sourceType",id:"parseroptionssourcetype",level:4},{value:"<del>plugins</del>",id:"plugins",level:3},{value:"<del>rules</del>",id:"rules",level:3},{value:"rules.arrow-body-style",id:"rulesarrow-body-style",level:4},{value:"rules.class-methods-use-this",id:"rulesclass-methods-use-this",level:4},{value:"rules.complexity",id:"rulescomplexity",level:4},{value:"rules.eslint-comments/disable-enable-pair",id:"ruleseslint-commentsdisable-enable-pair",level:4},{value:"rules.import/extensions",id:"rulesimportextensions",level:4},{value:"rules.import/imports-first",id:"rulesimportimports-first",level:4},{value:"rules.import/newline-after-import",id:"rulesimportnewline-after-import",level:4},{value:"rules.import/no-dynamic-require",id:"rulesimportno-dynamic-require",level:4},{value:"rules.import/no-extraneous-dependencies",id:"rulesimportno-extraneous-dependencies",level:4},{value:"rules.import/no-named-as-default",id:"rulesimportno-named-as-default",level:4},{value:"rules.import/no-unresolved",id:"rulesimportno-unresolved",level:4},{value:"rules.import/no-webpack-loader-syntax",id:"rulesimportno-webpack-loader-syntax",level:4},{value:"rules.import/prefer-default-export",id:"rulesimportprefer-default-export",level:4},{value:"rules.indent",id:"rulesindent",level:4},{value:"rules.jsdoc/require-jsdoc",id:"rulesjsdocrequire-jsdoc",level:4},{value:"rules.max-depth",id:"rulesmax-depth",level:4},{value:"rules.max-len",id:"rulesmax-len",level:4},{value:"rules.max-lines",id:"rulesmax-lines",level:4},{value:"rules.max-lines-per-function",id:"rulesmax-lines-per-function",level:4},{value:"rules.max-nested-callbacks",id:"rulesmax-nested-callbacks",level:4},{value:"rules.max-params",id:"rulesmax-params",level:4},{value:"rules.max-statements",id:"rulesmax-statements",level:4},{value:"rules.newline-per-chained-call",id:"rulesnewline-per-chained-call",level:4},{value:"rules.no-confusing-arrow",id:"rulesno-confusing-arrow",level:4},{value:"rules.no-console",id:"rulesno-console",level:4},{value:"rules.no-param-reassign",id:"rulesno-param-reassign",level:4},{value:"rules.no-unused-vars",id:"rulesno-unused-vars",level:4},{value:"rules.no-use-before-define",id:"rulesno-use-before-define",level:4},{value:"rules.prefer-template",id:"rulesprefer-template",level:4},{value:"rules.prettier/prettier",id:"rulesprettierprettier",level:4},{value:"rules.require-yield",id:"rulesrequire-yield",level:4},{value:"<del>settings</del>",id:"settings",level:3},{value:"settings.import/resolver",id:"settingsimportresolver",level:4},{value:"settings.import/resolver.node",id:"settingsimportresolvernode",level:4},{value:"settings.import/resolver.node.extensions",id:"settingsimportresolvernodeextensions",level:4},{value:"settings.jest",id:"settingsjest",level:4},{value:"settings.jest.version",id:"settingsjestversion",level:4},{value:"settings.react",id:"settingsreact",level:4},{value:"settings.react.version",id:"settingsreactversion",level:4},{value:"Deprecated",id:"deprecated",level:2}];function c(e){const n={code:"code",del:"del",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.header,{children:(0,l.jsx)(n.h1,{id:"eslintbaseconfig",children:(0,l.jsx)(n.del,{children:"eslintBaseConfig"})})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"eslintBaseConfig: {\n env: {\n browser: boolean;\n es2021: boolean;\n jest: boolean;\n node: boolean;\n };\n extends: string[];\n ignorePatterns: string[];\n overrides: {\n files: string[];\n rules: {\n jest/valid-expect: string;\n };\n }[];\n parser: string;\n parserOptions: {\n babelOptions: {\n plugins: string[];\n };\n ecmaFeatures: {\n jsx: boolean;\n };\n sourceType: string;\n };\n plugins: string[];\n rules: {\n arrow-body-style: (string | number)[];\n class-methods-use-this: number;\n complexity: (\n | string\n | {\n max: number;\n })[];\n eslint-comments/disable-enable-pair: number;\n import/extensions: (\n | string\n | number\n | {\n js: string;\n json: string;\n })[];\n import/imports-first: number;\n import/newline-after-import: number;\n import/no-dynamic-require: number;\n import/no-extraneous-dependencies: number;\n import/no-named-as-default: number;\n import/no-unresolved: (\n | number\n | {\n caseSensitive: boolean;\n caseSensitiveStrict: boolean;\n })[];\n import/no-webpack-loader-syntax: number;\n import/prefer-default-export: number;\n indent: (\n | number\n | {\n SwitchCase: number;\n })[];\n jsdoc/require-jsdoc: number;\n max-depth: (\n | string\n | {\n max: number;\n })[];\n max-len: number;\n max-lines: (\n | string\n | {\n max: number;\n skipComments: boolean;\n })[];\n max-lines-per-function: number;\n max-nested-callbacks: (\n | string\n | {\n max: number;\n })[];\n max-params: (\n | string\n | {\n max: number;\n })[];\n max-statements: (\n | string\n | {\n max: number;\n })[];\n newline-per-chained-call: number;\n no-confusing-arrow: number;\n no-console: number;\n no-param-reassign: (\n | string\n | {\n props: boolean;\n })[];\n no-unused-vars: number;\n no-use-before-define: number;\n prefer-template: number;\n prettier/prettier: (string | __module)[];\n require-yield: number;\n };\n settings: {\n import/resolver: {\n node: {\n extensions: string[];\n };\n };\n jest: {\n version: number;\n };\n react: {\n version: string;\n };\n };\n};\n"})}),"\n",(0,l.jsx)(n.h2,{id:"type-declaration",children:"Type Declaration"}),"\n",(0,l.jsx)(n.h3,{id:"env",children:(0,l.jsx)(n.del,{children:"env"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"env: {\n browser: boolean;\n es2021: boolean;\n jest: boolean;\n node: boolean;\n};\n"})}),"\n",(0,l.jsx)(n.h4,{id:"envbrowser",children:"env.browser"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"browser: boolean = true;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"enves2021",children:"env.es2021"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"es2021: boolean = true;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"envjest",children:"env.jest"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"jest: boolean = true;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"envnode",children:"env.node"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"node: boolean = true;\n"})}),"\n",(0,l.jsx)(n.h3,{id:"extends",children:(0,l.jsx)(n.del,{children:"extends"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"extends: string[];\n"})}),"\n",(0,l.jsx)(n.h3,{id:"ignorepatterns",children:(0,l.jsx)(n.del,{children:"ignorePatterns"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"ignorePatterns: string[];\n"})}),"\n",(0,l.jsx)(n.h3,{id:"overrides",children:(0,l.jsx)(n.del,{children:"overrides"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"overrides: {\n files: string[];\n rules: {\n jest/valid-expect: string;\n };\n}[];\n"})}),"\n",(0,l.jsx)(n.h3,{id:"parser",children:(0,l.jsx)(n.del,{children:"parser"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:'parser: string = "@babel/eslint-parser";\n'})}),"\n",(0,l.jsx)(n.h3,{id:"parseroptions",children:(0,l.jsx)(n.del,{children:"parserOptions"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"parserOptions: {\n babelOptions: {\n plugins: string[];\n };\n ecmaFeatures: {\n jsx: boolean;\n };\n sourceType: string;\n};\n"})}),"\n",(0,l.jsx)(n.h4,{id:"parseroptionsbabeloptions",children:"parserOptions.babelOptions"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"babelOptions: {\n plugins: string[];\n};\n"})}),"\n",(0,l.jsx)(n.h4,{id:"parseroptionsbabeloptionsplugins",children:"parserOptions.babelOptions.plugins"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"plugins: string[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"parseroptionsecmafeatures",children:"parserOptions.ecmaFeatures"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"ecmaFeatures: {\n jsx: boolean;\n};\n"})}),"\n",(0,l.jsx)(n.h4,{id:"parseroptionsecmafeaturesjsx",children:"parserOptions.ecmaFeatures.jsx"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"jsx: boolean = true;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"parseroptionssourcetype",children:"parserOptions.sourceType"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:'sourceType: string = "module";\n'})}),"\n",(0,l.jsx)(n.h3,{id:"plugins",children:(0,l.jsx)(n.del,{children:"plugins"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"plugins: string[] = basePlugins;\n"})}),"\n",(0,l.jsx)(n.h3,{id:"rules",children:(0,l.jsx)(n.del,{children:"rules"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"rules: {\n arrow-body-style: (string | number)[];\n class-methods-use-this: number;\n complexity: (\n | string\n | {\n max: number;\n })[];\n eslint-comments/disable-enable-pair: number;\n import/extensions: (\n | string\n | number\n | {\n js: string;\n json: string;\n })[];\n import/imports-first: number;\n import/newline-after-import: number;\n import/no-dynamic-require: number;\n import/no-extraneous-dependencies: number;\n import/no-named-as-default: number;\n import/no-unresolved: (\n | number\n | {\n caseSensitive: boolean;\n caseSensitiveStrict: boolean;\n })[];\n import/no-webpack-loader-syntax: number;\n import/prefer-default-export: number;\n indent: (\n | number\n | {\n SwitchCase: number;\n })[];\n jsdoc/require-jsdoc: number;\n max-depth: (\n | string\n | {\n max: number;\n })[];\n max-len: number;\n max-lines: (\n | string\n | {\n max: number;\n skipComments: boolean;\n })[];\n max-lines-per-function: number;\n max-nested-callbacks: (\n | string\n | {\n max: number;\n })[];\n max-params: (\n | string\n | {\n max: number;\n })[];\n max-statements: (\n | string\n | {\n max: number;\n })[];\n newline-per-chained-call: number;\n no-confusing-arrow: number;\n no-console: number;\n no-param-reassign: (\n | string\n | {\n props: boolean;\n })[];\n no-unused-vars: number;\n no-use-before-define: number;\n prefer-template: number;\n prettier/prettier: (string | __module)[];\n require-yield: number;\n} = baseRules;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesarrow-body-style",children:"rules.arrow-body-style"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"arrow-body-style: (string | number)[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesclass-methods-use-this",children:"rules.class-methods-use-this"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"class-methods-use-this: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulescomplexity",children:"rules.complexity"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"complexity: (\n | string\n | {\n max: number;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"ruleseslint-commentsdisable-enable-pair",children:"rules.eslint-comments/disable-enable-pair"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"eslint-comments/disable-enable-pair: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesimportextensions",children:"rules.import/extensions"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import/extensions: (\n | string\n | number\n | {\n js: string;\n json: string;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesimportimports-first",children:"rules.import/imports-first"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import/imports-first: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesimportnewline-after-import",children:"rules.import/newline-after-import"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import/newline-after-import: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesimportno-dynamic-require",children:"rules.import/no-dynamic-require"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import/no-dynamic-require: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesimportno-extraneous-dependencies",children:"rules.import/no-extraneous-dependencies"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import/no-extraneous-dependencies: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesimportno-named-as-default",children:"rules.import/no-named-as-default"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import/no-named-as-default: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesimportno-unresolved",children:"rules.import/no-unresolved"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import/no-unresolved: (\n | number\n | {\n caseSensitive: boolean;\n caseSensitiveStrict: boolean;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesimportno-webpack-loader-syntax",children:"rules.import/no-webpack-loader-syntax"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import/no-webpack-loader-syntax: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesimportprefer-default-export",children:"rules.import/prefer-default-export"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import/prefer-default-export: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesindent",children:"rules.indent"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"indent: (\n | number\n | {\n SwitchCase: number;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesjsdocrequire-jsdoc",children:"rules.jsdoc/require-jsdoc"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"jsdoc/require-jsdoc: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesmax-depth",children:"rules.max-depth"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"max-depth: (\n | string\n | {\n max: number;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesmax-len",children:"rules.max-len"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"max-len: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesmax-lines",children:"rules.max-lines"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"max-lines: (\n | string\n | {\n max: number;\n skipComments: boolean;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesmax-lines-per-function",children:"rules.max-lines-per-function"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"max-lines-per-function: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesmax-nested-callbacks",children:"rules.max-nested-callbacks"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"max-nested-callbacks: (\n | string\n | {\n max: number;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesmax-params",children:"rules.max-params"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"max-params: (\n | string\n | {\n max: number;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesmax-statements",children:"rules.max-statements"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"max-statements: (\n | string\n | {\n max: number;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesnewline-per-chained-call",children:"rules.newline-per-chained-call"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"newline-per-chained-call: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesno-confusing-arrow",children:"rules.no-confusing-arrow"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"no-confusing-arrow: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesno-console",children:"rules.no-console"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"no-console: number = 1;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesno-param-reassign",children:"rules.no-param-reassign"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"no-param-reassign: (\n | string\n | {\n props: boolean;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesno-unused-vars",children:"rules.no-unused-vars"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"no-unused-vars: number = 2;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesno-use-before-define",children:"rules.no-use-before-define"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"no-use-before-define: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesprefer-template",children:"rules.prefer-template"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"prefer-template: number = 2;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesprettierprettier",children:"rules.prettier/prettier"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"prettier/prettier: (string | __module)[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesrequire-yield",children:"rules.require-yield"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"require-yield: number = 0;\n"})}),"\n",(0,l.jsx)(n.h3,{id:"settings",children:(0,l.jsx)(n.del,{children:"settings"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"settings: {\n import/resolver: {\n node: {\n extensions: string[];\n };\n };\n jest: {\n version: number;\n };\n react: {\n version: string;\n };\n};\n"})}),"\n",(0,l.jsx)(n.h4,{id:"settingsimportresolver",children:"settings.import/resolver"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import/resolver: {\n node: {\n extensions: string[];\n };\n};\n"})}),"\n",(0,l.jsx)(n.h4,{id:"settingsimportresolvernode",children:"settings.import/resolver.node"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"node: {\n extensions: string[];\n};\n"})}),"\n",(0,l.jsx)(n.h4,{id:"settingsimportresolvernodeextensions",children:"settings.import/resolver.node.extensions"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"extensions: string[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"settingsjest",children:"settings.jest"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"jest: {\n version: number;\n};\n"})}),"\n",(0,l.jsx)(n.h4,{id:"settingsjestversion",children:"settings.jest.version"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"version: number = 28;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"settingsreact",children:"settings.react"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react: {\n version: string;\n};\n"})}),"\n",(0,l.jsx)(n.h4,{id:"settingsreactversion",children:"settings.react.version"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:'version: string = "detect";\n'})}),"\n",(0,l.jsx)(n.h2,{id:"deprecated",children:"Deprecated"}),"\n",(0,l.jsx)(n.p,{children:"Use eslintFlatBaseConfig in eslint.config.mjs"})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(c,{...e})}):c(e)}},6607(e,n,s){s.d(n,{R:()=>a,x:()=>t});var r=s(758);const l={},i=r.createContext(l);function a(e){const n=r.useContext(i);return r.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:a(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]);
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
"use strict";(globalThis.webpackChunk_elliemae_pui_cli=globalThis.webpackChunk_elliemae_pui_cli||[]).push([[2577],{8768(e,i,n){n.r(i),n.d(i,{assets:()=>r,contentTitle:()=>s,default:()=>m,frontMatter:()=>o,metadata:()=>t,toc:()=>c});const t=JSON.parse('{"id":"api/variables/commitlintConfig","title":"commitlintConfig","description":"Type Declaration","source":"@site/docs/api/variables/commitlintConfig.md","sourceDirName":"api/variables","slug":"/api/variables/commitlintConfig","permalink":"/cli/api/variables/commitlintConfig","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-cli.git/docs/api/variables/commitlintConfig.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"babelConfig","permalink":"/cli/api/variables/babelConfig"},"next":{"title":"~~eslintBaseConfig~~","permalink":"/cli/api/variables/eslintBaseConfig"}}');var a=n(6070),l=n(6607);const o={},s="commitlintConfig",r={},c=[{value:"Type Declaration",id:"type-declaration",level:2},{value:"extends",id:"extends",level:3}];function d(e){const i={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",pre:"pre",...(0,l.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(i.header,{children:(0,a.jsx)(i.h1,{id:"commitlintconfig",children:"commitlintConfig"})}),"\n",(0,a.jsx)(i.pre,{children:(0,a.jsx)(i.code,{className:"language-ts",children:"commitlintConfig: {\n extends: string[];\n};\n"})}),"\n",(0,a.jsx)(i.h2,{id:"type-declaration",children:"Type Declaration"}),"\n",(0,a.jsx)(i.h3,{id:"extends",children:"extends"}),"\n",(0,a.jsx)(i.pre,{children:(0,a.jsx)(i.code,{className:"language-ts",children:"extends: string[];\n"})})]})}function m(e={}){const{wrapper:i}={...(0,l.R)(),...e.components};return i?(0,a.jsx)(i,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},6607(e,i,n){n.d(i,{R:()=>o,x:()=>s});var t=n(758);const a={},l=t.createContext(a);function o(e){const i=t.useContext(l);return t.useMemo(function(){return"function"==typeof e?e(i):{...i,...e}},[i,e])}function s(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:o(e.components),t.createElement(l.Provider,{value:i},e.children)}}}]);
|