tiktok-sparo/assets/js/238e4522.81c445bd.js

"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[774],{5286:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>i,default:()=>d,frontMatter:()=>s,metadata:()=>a,toc:()=>c});var t=r(678),o=r(4738);const s={title:"<profile-name>.json"},i=void 0,a={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,o.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:'/**\r\n * OWNER:   <your team name>\r\n * PURPOSE: <what you use this profile for>\r\n */\r\n{\r\n  "$schema": "https://tiktok.github.io/sparo/schemas/sparo-profile.schema.json",\r\n\r\n  /**\r\n   * A list of Rush project selectors indicating the project folders to be\r\n   * included for sparse checkout.  The selectors will be combined to make\r\n   * the union superset of projects.  See the Rush selector docs for details:\r\n   * https://rushjs.io/pages/developer/selecting_subsets/\r\n   */\r\n  "selections": [\r\n    /**\r\n     * For example, include all Rush projects tagged with "tag:my-team"\r\n     * as well as the dependency workspace projects needed to build them.\r\n     */\r\n    // {\r\n    //   "selector": "--to",\r\n    //   "argument": "tag:my-team"\r\n    // },\r\n    /**\r\n     * For example, include the project called "my-library", as well as all\r\n     * projects that are impacted by changes to it, as well as the dependency\r\n     * projects needed to build everything.\r\n     */\r\n    // {\r\n    //   "selector": "--from",\r\n    //   "argument": "my-library"\r\n    // }\r\n  ],\r\n\r\n  /**\r\n   * A list of arbitrary additional folders to be included for checkout,\r\n   * not necessarily corresponding to any workspace project.\r\n   */\r\n  "includeFolders": [\r\n    // "path/to/include"\r\n  ],\r\n\r\n  /**\r\n   * A list of folders to be excluded from the checkout.  This field takes precedence\r\n   * over the "includeFolders" and "selections" fields, guaranteeing that the\r\n   * specified path will definitely not be included.\r\n   */\r\n  "excludeFolders": [\r\n    // "path/to/exclude"\r\n  ]\r\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,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},4738:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>a});var t=r(6166);const o={},s=t.createContext(o);function i(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]);