tiktok-sparo/assets/js/238e4522.19704b89.js

"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[774],{5286:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>d,frontMatter:()=>r,metadata:()=>i,toc:()=>c});var t=o(678),s=o(4738);const r={title:"<profile-name>.json"},a=void 0,i={id:"pages/configs/profile_json",title:"<profile-name>.json",description:"To initialize a new Sparo profile, you can copy and paste the contents of this template.",source:"@site/docs/pages/configs/profile_json.md",sourceDirName:"pages/configs",slug:"/pages/configs/profile_json",permalink:"/sparo/pages/configs/profile_json",draft:!1,unlisted:!1,editUrl:"https://github.com/tiktok/sparo/tree/main/apps/website/docs/pages/configs/profile_json.md",tags:[],version:"current",frontMatter:{title:"<profile-name>.json"},sidebar:"docsSidebar",previous:{title:"Security",permalink:"/sparo/pages/reference/security"},next:{title:"Overview",permalink:"/sparo/pages/commands/overview"}},l={},c=[{value:"See also",id:"see-also",level:2}];function p(e){const n={a:"a",code:"code",h2:"h2",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.p,{children:"To initialize a new Sparo profile, you can copy and paste the contents of this template."}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"common/sparo-profiles/<profile-name>.json"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-js",children:'/**\n * OWNER:   <your team name>\n * PURPOSE: <what you use this profile for>\n */\n{\n  "$schema": "https://tiktok.github.io/sparo/schemas/sparo-profile.schema.json",\n\n  /**\n   * A list of Rush project selectors indicating the project folders to be\n   * included for sparse checkout.  The selectors will be combined to make\n   * the union superset of projects.  See the Rush selector docs for details:\n   * https://rushjs.io/pages/developer/selecting_subsets/\n   */\n  "selections": [\n    /**\n     * For example, include all Rush projects tagged with "tag:my-team"\n     * as well as the dependency workspace projects needed to build them.\n     * To learn about Rush project tags, see this documentation:\n     * https://rushjs.io/pages/developer/project_tags/\n     */\n    // {\n    //   "selector": "--to",\n    //   "argument": "tag:my-team"\n    // },\n    /**\n     * For example, include the project called "my-library", as well as all\n     * projects that are impacted by changes to it, as well as the dependency\n     * projects needed to build everything.\n     */\n    // {\n    //   "selector": "--from",\n    //   "argument": "my-library"\n    // }\n  ],\n\n  /**\n   * A list of arbitrary additional folders to be included for checkout,\n   * not necessarily corresponding to any workspace project.\n   * The paths should use forward slashes, without a leading slash, and should be to the \n   * root folder of the monorepo.  Wildcards and glob patterns are not supported for\n   * performance reasons.\n   */\n  "includeFolders": [\n    // "path/to/include"\n  ],\n\n  /**\n   * A list of folders to be excluded from the checkout.  This field takes precedence\n   * over the "includeFolders" and "selections" fields, guaranteeing that the\n   * specified path will definitely not be included.\n   * The paths should use forward slashes, without a leading slash, and should be to the \n   * root folder of the monorepo.  Wildcards and glob patterns are not supported for\n   * performance reasons.\n   */\n  "excludeFolders": [\n    // "path/to/exclude"\n  ]\n}\n'})}),"\n",(0,t.jsx)(n.h2,{id:"see-also",children:"See also"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/sparo/pages/guide/sparo_profiles",children:"Sparo profiles"})}),"\n"]})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},4738:(e,n,o)=>{o.d(n,{R:()=>a,x:()=>i});var t=o(6166);const s={},r=t.createContext(s);function a(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]);