@skeptools/skep-organization-project 0.0.0

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.
Files changed (137) hide show
  1. package/.gitattributes +23 -0
  2. package/.jsii +164 -0
  3. package/.projenrc.ts +29 -0
  4. package/API.md +3610 -0
  5. package/LICENSE +202 -0
  6. package/README.md +8 -0
  7. package/files/generated/.seed +1 -0
  8. package/files/scaffolding/.seed +1 -0
  9. package/files/scaffolding/README.md.liquid +43 -0
  10. package/lib/index.d.ts +1 -0
  11. package/lib/index.js +14 -0
  12. package/lib/skep-organization-project.d.ts +7 -0
  13. package/lib/skep-organization-project.js +24 -0
  14. package/node_modules/liquidjs/CHANGELOG.md +1015 -0
  15. package/node_modules/liquidjs/LICENSE +21 -0
  16. package/node_modules/liquidjs/README.md +163 -0
  17. package/node_modules/liquidjs/bin/liquid.js +24 -0
  18. package/node_modules/liquidjs/dist/builtin/filters/array.d.ts +15 -0
  19. package/node_modules/liquidjs/dist/builtin/filters/date.d.ts +2 -0
  20. package/node_modules/liquidjs/dist/builtin/filters/html.d.ts +4 -0
  21. package/node_modules/liquidjs/dist/builtin/filters/index.d.ts +7 -0
  22. package/node_modules/liquidjs/dist/builtin/filters/math.d.ts +11 -0
  23. package/node_modules/liquidjs/dist/builtin/filters/misc.d.ts +5 -0
  24. package/node_modules/liquidjs/dist/builtin/filters/string.d.ts +16 -0
  25. package/node_modules/liquidjs/dist/builtin/filters/url.d.ts +2 -0
  26. package/node_modules/liquidjs/dist/builtin/tags/assign.d.ts +3 -0
  27. package/node_modules/liquidjs/dist/builtin/tags/block.d.ts +8 -0
  28. package/node_modules/liquidjs/dist/builtin/tags/break.d.ts +5 -0
  29. package/node_modules/liquidjs/dist/builtin/tags/capture.d.ts +3 -0
  30. package/node_modules/liquidjs/dist/builtin/tags/case.d.ts +3 -0
  31. package/node_modules/liquidjs/dist/builtin/tags/comment.d.ts +3 -0
  32. package/node_modules/liquidjs/dist/builtin/tags/continue.d.ts +5 -0
  33. package/node_modules/liquidjs/dist/builtin/tags/cycle.d.ts +3 -0
  34. package/node_modules/liquidjs/dist/builtin/tags/decrement.d.ts +3 -0
  35. package/node_modules/liquidjs/dist/builtin/tags/echo.d.ts +3 -0
  36. package/node_modules/liquidjs/dist/builtin/tags/for.d.ts +3 -0
  37. package/node_modules/liquidjs/dist/builtin/tags/if.d.ts +3 -0
  38. package/node_modules/liquidjs/dist/builtin/tags/include.d.ts +3 -0
  39. package/node_modules/liquidjs/dist/builtin/tags/increment.d.ts +3 -0
  40. package/node_modules/liquidjs/dist/builtin/tags/index.d.ts +5 -0
  41. package/node_modules/liquidjs/dist/builtin/tags/inline-comment.d.ts +3 -0
  42. package/node_modules/liquidjs/dist/builtin/tags/layout.d.ts +3 -0
  43. package/node_modules/liquidjs/dist/builtin/tags/liquid.d.ts +3 -0
  44. package/node_modules/liquidjs/dist/builtin/tags/raw.d.ts +3 -0
  45. package/node_modules/liquidjs/dist/builtin/tags/render.d.ts +13 -0
  46. package/node_modules/liquidjs/dist/builtin/tags/tablerow.d.ts +3 -0
  47. package/node_modules/liquidjs/dist/builtin/tags/unless.d.ts +3 -0
  48. package/node_modules/liquidjs/dist/cache/cache.d.ts +7 -0
  49. package/node_modules/liquidjs/dist/cache/lru.d.ts +14 -0
  50. package/node_modules/liquidjs/dist/context/block-mode.d.ts +5 -0
  51. package/node_modules/liquidjs/dist/context/context.d.ts +53 -0
  52. package/node_modules/liquidjs/dist/context/scope.d.ts +6 -0
  53. package/node_modules/liquidjs/dist/drop/blank-drop.d.ts +4 -0
  54. package/node_modules/liquidjs/dist/drop/block-drop.d.ts +10 -0
  55. package/node_modules/liquidjs/dist/drop/comparable.d.ts +8 -0
  56. package/node_modules/liquidjs/dist/drop/drop.d.ts +3 -0
  57. package/node_modules/liquidjs/dist/drop/empty-drop.d.ts +10 -0
  58. package/node_modules/liquidjs/dist/drop/forloop-drop.d.ts +15 -0
  59. package/node_modules/liquidjs/dist/drop/null-drop.d.ts +10 -0
  60. package/node_modules/liquidjs/dist/drop/tablerowloop-drop.d.ts +10 -0
  61. package/node_modules/liquidjs/dist/emitters/emitter.d.ts +11 -0
  62. package/node_modules/liquidjs/dist/emitters/keeping-type-emitter.d.ts +5 -0
  63. package/node_modules/liquidjs/dist/emitters/simple-emitter.d.ts +5 -0
  64. package/node_modules/liquidjs/dist/emitters/streamed-emitter-browser.d.ts +10 -0
  65. package/node_modules/liquidjs/dist/emitters/streamed-emitter.d.ts +9 -0
  66. package/node_modules/liquidjs/dist/fs/browser.d.ts +7 -0
  67. package/node_modules/liquidjs/dist/fs/fs.d.ts +20 -0
  68. package/node_modules/liquidjs/dist/fs/loader.d.ts +24 -0
  69. package/node_modules/liquidjs/dist/fs/node-require.d.ts +2 -0
  70. package/node_modules/liquidjs/dist/fs/node.d.ts +9 -0
  71. package/node_modules/liquidjs/dist/liquid-options.d.ts +128 -0
  72. package/node_modules/liquidjs/dist/liquid.browser.esm.js +3523 -0
  73. package/node_modules/liquidjs/dist/liquid.browser.min.js +2 -0
  74. package/node_modules/liquidjs/dist/liquid.browser.min.js.map +1 -0
  75. package/node_modules/liquidjs/dist/liquid.browser.umd.js +4811 -0
  76. package/node_modules/liquidjs/dist/liquid.browser.umd.js.map +1 -0
  77. package/node_modules/liquidjs/dist/liquid.d.ts +43 -0
  78. package/node_modules/liquidjs/dist/liquid.node.cjs.js +4820 -0
  79. package/node_modules/liquidjs/dist/liquid.node.esm.js +3540 -0
  80. package/node_modules/liquidjs/dist/parser/filter-arg.d.ts +5 -0
  81. package/node_modules/liquidjs/dist/parser/match-operator.d.ts +2 -0
  82. package/node_modules/liquidjs/dist/parser/parse-stream.d.ts +16 -0
  83. package/node_modules/liquidjs/dist/parser/parse-string-literal.d.ts +1 -0
  84. package/node_modules/liquidjs/dist/parser/parser.d.ts +22 -0
  85. package/node_modules/liquidjs/dist/parser/token-kind.d.ts +15 -0
  86. package/node_modules/liquidjs/dist/parser/tokenizer.d.ts +66 -0
  87. package/node_modules/liquidjs/dist/parser/whitespace-ctrl.d.ts +3 -0
  88. package/node_modules/liquidjs/dist/render/boolean.d.ts +3 -0
  89. package/node_modules/liquidjs/dist/render/expression.d.ts +14 -0
  90. package/node_modules/liquidjs/dist/render/operator.d.ts +5 -0
  91. package/node_modules/liquidjs/dist/render/render.d.ts +8 -0
  92. package/node_modules/liquidjs/dist/template/filter/filter-impl-options.d.ts +4 -0
  93. package/node_modules/liquidjs/dist/template/filter/filter-impl.d.ts +6 -0
  94. package/node_modules/liquidjs/dist/template/filter/filter-map.d.ts +13 -0
  95. package/node_modules/liquidjs/dist/template/filter/filter.d.ts +12 -0
  96. package/node_modules/liquidjs/dist/template/html.d.ts +10 -0
  97. package/node_modules/liquidjs/dist/template/output.d.ts +11 -0
  98. package/node_modules/liquidjs/dist/template/tag/hash.d.ts +17 -0
  99. package/node_modules/liquidjs/dist/template/tag/tag-impl-options.d.ts +10 -0
  100. package/node_modules/liquidjs/dist/template/tag/tag-impl.d.ts +6 -0
  101. package/node_modules/liquidjs/dist/template/tag/tag-map.d.ts +6 -0
  102. package/node_modules/liquidjs/dist/template/tag/tag.d.ts +10 -0
  103. package/node_modules/liquidjs/dist/template/template-impl.d.ts +4 -0
  104. package/node_modules/liquidjs/dist/template/template.d.ts +7 -0
  105. package/node_modules/liquidjs/dist/template/value.d.ts +13 -0
  106. package/node_modules/liquidjs/dist/tokens/delimited-token.d.ts +8 -0
  107. package/node_modules/liquidjs/dist/tokens/filter-token.d.ts +7 -0
  108. package/node_modules/liquidjs/dist/tokens/hash-token.d.ts +12 -0
  109. package/node_modules/liquidjs/dist/tokens/html-token.d.ts +11 -0
  110. package/node_modules/liquidjs/dist/tokens/identifier-token.d.ts +10 -0
  111. package/node_modules/liquidjs/dist/tokens/liquid-tag-token.d.ts +7 -0
  112. package/node_modules/liquidjs/dist/tokens/literal-token.d.ts +9 -0
  113. package/node_modules/liquidjs/dist/tokens/number-token.d.ts +7 -0
  114. package/node_modules/liquidjs/dist/tokens/operator-token.d.ts +21 -0
  115. package/node_modules/liquidjs/dist/tokens/output-token.d.ts +5 -0
  116. package/node_modules/liquidjs/dist/tokens/property-access-token.d.ts +9 -0
  117. package/node_modules/liquidjs/dist/tokens/quoted-token.d.ts +8 -0
  118. package/node_modules/liquidjs/dist/tokens/range-token.d.ts +11 -0
  119. package/node_modules/liquidjs/dist/tokens/tag-token.d.ts +7 -0
  120. package/node_modules/liquidjs/dist/tokens/token.d.ts +12 -0
  121. package/node_modules/liquidjs/dist/tokens/toplevel-token.d.ts +4 -0
  122. package/node_modules/liquidjs/dist/tokens/value-token.d.ts +5 -0
  123. package/node_modules/liquidjs/dist/types.d.ts +30 -0
  124. package/node_modules/liquidjs/dist/util/assert.d.ts +1 -0
  125. package/node_modules/liquidjs/dist/util/async.d.ts +3 -0
  126. package/node_modules/liquidjs/dist/util/character.d.ts +8 -0
  127. package/node_modules/liquidjs/dist/util/collection.d.ts +2 -0
  128. package/node_modules/liquidjs/dist/util/error.d.ts +29 -0
  129. package/node_modules/liquidjs/dist/util/liquid-date.d.ts +19 -0
  130. package/node_modules/liquidjs/dist/util/literal.d.ts +11 -0
  131. package/node_modules/liquidjs/dist/util/operator-trie.d.ts +5 -0
  132. package/node_modules/liquidjs/dist/util/strftime.d.ts +2 -0
  133. package/node_modules/liquidjs/dist/util/timezone-date.d.ts +39 -0
  134. package/node_modules/liquidjs/dist/util/type-guards.d.ts +22 -0
  135. package/node_modules/liquidjs/dist/util/underscore.d.ts +37 -0
  136. package/node_modules/liquidjs/package.json +165 -0
  137. package/package.json +133 -0
package/API.md ADDED
@@ -0,0 +1,3610 @@
1
+ # API Reference <a name="API Reference" id="api-reference"></a>
2
+
3
+
4
+ ## Structs <a name="Structs" id="Structs"></a>
5
+
6
+ ### SkepOrganizationProjectOptions <a name="SkepOrganizationProjectOptions" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions"></a>
7
+
8
+ #### Initializer <a name="Initializer" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.Initializer"></a>
9
+
10
+ ```typescript
11
+ import { SkepOrganizationProjectOptions } from '@skeptools/skep-organization-project'
12
+
13
+ const skepOrganizationProjectOptions: SkepOrganizationProjectOptions = { ... }
14
+ ```
15
+
16
+ #### Properties <a name="Properties" id="Properties"></a>
17
+
18
+ | **Name** | **Type** | **Description** |
19
+ | --- | --- | --- |
20
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.name">name</a></code> | <code>string</code> | This is the name of your project. |
21
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
22
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.logging">logging</a></code> | <code>projen.LoggerOptions</code> | Configure logging options such as verbosity. |
23
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.outdir">outdir</a></code> | <code>string</code> | The root directory of the project. |
24
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.parent">parent</a></code> | <code>projen.Project</code> | The parent project, if this project is part of a bigger project. |
25
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.projenCommand">projenCommand</a></code> | <code>string</code> | The shell command to use in order to run the projen CLI. |
26
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.projenrcJson">projenrcJson</a></code> | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. |
27
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.projenrcJsonOptions">projenrcJsonOptions</a></code> | <code>projen.ProjenrcOptions</code> | Options for .projenrc.json. |
28
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.renovatebot">renovatebot</a></code> | <code>boolean</code> | Use renovatebot to handle dependency upgrades. |
29
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.renovatebotOptions">renovatebotOptions</a></code> | <code>projen.RenovatebotOptions</code> | Options for renovatebot. |
30
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.autoApproveOptions">autoApproveOptions</a></code> | <code>projen.github.AutoApproveOptions</code> | Enable and configure the 'auto approve' workflow. |
31
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.autoMerge">autoMerge</a></code> | <code>boolean</code> | Enable automatic merging on GitHub. |
32
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.autoMergeOptions">autoMergeOptions</a></code> | <code>projen.github.AutoMergeOptions</code> | Configure options for automatic merging on GitHub. |
33
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
34
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.devContainer">devContainer</a></code> | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces). |
35
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.github">github</a></code> | <code>boolean</code> | Enable GitHub integration. |
36
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.githubOptions">githubOptions</a></code> | <code>projen.github.GitHubOptions</code> | Options for GitHub integration. |
37
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.gitpod">gitpod</a></code> | <code>boolean</code> | Add a Gitpod development environment. |
38
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.mergify">mergify</a></code> | <code>boolean</code> | Whether mergify should be enabled on this repository or not. |
39
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.mergifyOptions">mergifyOptions</a></code> | <code>projen.github.MergifyOptions</code> | Options for mergify. |
40
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | Which type of project this is (library/app). |
41
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.projenCredentials">projenCredentials</a></code> | <code>projen.github.GithubCredentials</code> | Choose a method of providing GitHub API access for projen workflows. |
42
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.projenTokenSecret">projenTokenSecret</a></code> | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. |
43
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.readme">readme</a></code> | <code>projen.SampleReadmeProps</code> | The README setup. |
44
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.stale">stale</a></code> | <code>boolean</code> | Auto-close of stale issues and pull request. |
45
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.staleOptions">staleOptions</a></code> | <code>projen.github.StaleOptions</code> | Auto-close stale issues and pull requests. |
46
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.vscode">vscode</a></code> | <code>boolean</code> | Enable VSCode integration. |
47
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`. |
48
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.authorEmail">authorEmail</a></code> | <code>string</code> | Author's e-mail. |
49
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.authorName">authorName</a></code> | <code>string</code> | Author's name. |
50
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.authorOrganization">authorOrganization</a></code> | <code>boolean</code> | Is the author an organization. |
51
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.authorUrl">authorUrl</a></code> | <code>string</code> | Author's URL / Website. |
52
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.autoDetectBin">autoDetectBin</a></code> | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. |
53
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.bin">bin</a></code> | <code>{[ key: string ]: string}</code> | Binary programs vended with your module. |
54
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.bugsEmail">bugsEmail</a></code> | <code>string</code> | The email address to which issues should be reported. |
55
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.bugsUrl">bugsUrl</a></code> | <code>string</code> | The url to your project's issue tracker. |
56
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.bundledDeps">bundledDeps</a></code> | <code>string[]</code> | List of dependencies to bundle into this module. |
57
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
58
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.deps">deps</a></code> | <code>string[]</code> | Runtime dependencies of this module. |
59
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.description">description</a></code> | <code>string</code> | The description is just a string that helps people understand the purpose of the package. |
60
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.devDeps">devDeps</a></code> | <code>string[]</code> | Build dependencies for this module. |
61
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.entrypoint">entrypoint</a></code> | <code>string</code> | Module entrypoint (`main` in `package.json`). |
62
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.homepage">homepage</a></code> | <code>string</code> | Package's Homepage / Website. |
63
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.keywords">keywords</a></code> | <code>string[]</code> | Keywords to include in `package.json`. |
64
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.license">license</a></code> | <code>string</code> | License's SPDX identifier. |
65
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.licensed">licensed</a></code> | <code>boolean</code> | Indicates if a license should be added. |
66
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | Minimum node.js version to require via `engines` (inclusive). |
67
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive). |
68
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.npmAccess">npmAccess</a></code> | <code>projen.javascript.NpmAccess</code> | Access level of the npm package. |
69
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
70
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
71
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
72
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The Node Package Manager used to execute scripts. |
73
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
74
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.peerDependencyOptions">peerDependencyOptions</a></code> | <code>projen.javascript.PeerDependencyOptions</code> | Options for `peerDeps`. |
75
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.peerDeps">peerDeps</a></code> | <code>string[]</code> | Peer dependencies for this module. |
76
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.repository">repository</a></code> | <code>string</code> | The repository is the location where the actual code for your package lives. |
77
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.repositoryDirectory">repositoryDirectory</a></code> | <code>string</code> | If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. |
78
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.scopedPackagesOptions">scopedPackagesOptions</a></code> | <code>projen.javascript.ScopedPackagesOptions[]</code> | Options for privately hosted scoped packages. |
79
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.scripts">scripts</a></code> | <code>{[ key: string ]: string}</code> | npm scripts to include. |
80
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.stability">stability</a></code> | <code>string</code> | Package's Stability. |
81
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.jsiiReleaseVersion">jsiiReleaseVersion</a></code> | <code>string</code> | Version requirement of `publib` which is used to publish modules to npm. |
82
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.majorVersion">majorVersion</a></code> | <code>number</code> | Major version to release from the default branch. |
83
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.minMajorVersion">minMajorVersion</a></code> | <code>number</code> | Minimal Major version to release. |
84
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.npmDistTag">npmDistTag</a></code> | <code>string</code> | The npmDistTag to use when publishing from the default branch. |
85
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.postBuildSteps">postBuildSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | Steps to execute after build as part of the release workflow. |
86
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.prerelease">prerelease</a></code> | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). |
87
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.publishDryRun">publishDryRun</a></code> | <code>boolean</code> | Instead of actually publishing to package managers, just print the publishing command. |
88
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.publishTasks">publishTasks</a></code> | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows. |
89
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
90
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
91
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
92
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
93
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.releaseSchedule">releaseSchedule</a></code> | <code>string</code> | CRON schedule to trigger new releases. |
94
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.releaseTagPrefix">releaseTagPrefix</a></code> | <code>string</code> | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. |
95
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
96
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
97
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.releaseWorkflowSetupSteps">releaseWorkflowSetupSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | A set of workflow steps to execute in order to setup the workflow container. |
98
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.versionrcOptions">versionrcOptions</a></code> | <code>{[ key: string ]: any}</code> | Custom configuration used when creating changelog with standard-version package. |
99
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.workflowContainerImage">workflowContainerImage</a></code> | <code>string</code> | Container image to use for GitHub workflows. |
100
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
101
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
102
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
103
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.autoApproveUpgrades">autoApproveUpgrades</a></code> | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). |
104
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.buildWorkflow">buildWorkflow</a></code> | <code>boolean</code> | Define a GitHub workflow for building PRs. |
105
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
106
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
107
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with @codeCovTokenSecret. |
108
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. |
109
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
110
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
111
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
112
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.dependabotOptions">dependabotOptions</a></code> | <code>projen.github.DependabotOptions</code> | Options for dependabot. |
113
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.depsUpgrade">depsUpgrade</a></code> | <code>boolean</code> | Use github workflows to handle dependency upgrades. |
114
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.depsUpgradeOptions">depsUpgradeOptions</a></code> | <code>projen.javascript.UpgradeDependenciesOptions</code> | Options for `UpgradeDependencies`. |
115
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.gitignore">gitignore</a></code> | <code>string[]</code> | Additional entries to .gitignore. |
116
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.jest">jest</a></code> | <code>boolean</code> | Setup jest unit tests. |
117
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.jestOptions">jestOptions</a></code> | <code>projen.javascript.JestOptions</code> | Jest options. |
118
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.mutableBuild">mutableBuild</a></code> | <code>boolean</code> | Automatically update files modified during builds to pull-request branches. |
119
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.npmignore">npmignore</a></code> | <code>string[]</code> | Additional entries to .npmignore. |
120
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.npmignoreEnabled">npmignoreEnabled</a></code> | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. |
121
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.package">package</a></code> | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). |
122
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.prettier">prettier</a></code> | <code>boolean</code> | Setup prettier. |
123
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.prettierOptions">prettierOptions</a></code> | <code>projen.javascript.PrettierOptions</code> | Prettier options. |
124
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.projenDevDependency">projenDevDependency</a></code> | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency. |
125
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.projenrcJs">projenrcJs</a></code> | <code>boolean</code> | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. |
126
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.projenrcJsOptions">projenrcJsOptions</a></code> | <code>projen.javascript.ProjenrcOptions</code> | Options for .projenrc.js. |
127
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.projenVersion">projenVersion</a></code> | <code>string</code> | Version of projen to install. |
128
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.pullRequestTemplate">pullRequestTemplate</a></code> | <code>boolean</code> | Include a GitHub pull request template. |
129
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.pullRequestTemplateContents">pullRequestTemplateContents</a></code> | <code>string[]</code> | The contents of the pull request template. |
130
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.release">release</a></code> | <code>boolean</code> | Add release management to this project. |
131
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.releaseToNpm">releaseToNpm</a></code> | <code>boolean</code> | Automatically release to npm when new versions are introduced. |
132
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.releaseWorkflow">releaseWorkflow</a></code> | <code>boolean</code> | DEPRECATED: renamed to `release`. |
133
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.workflowBootstrapSteps">workflowBootstrapSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | Workflow steps to use in order to bootstrap this repo. |
134
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
135
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version to use in GitHub workflows. |
136
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.disableTsconfig">disableTsconfig</a></code> | <code>boolean</code> | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
137
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
138
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | Docs directory. |
139
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.entrypointTypes">entrypointTypes</a></code> | <code>string</code> | The .d.ts file that includes the type declarations for this module. |
140
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.eslint">eslint</a></code> | <code>boolean</code> | Setup eslint. |
141
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.eslintOptions">eslintOptions</a></code> | <code>projen.javascript.EslintOptions</code> | Eslint options. |
142
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.libdir">libdir</a></code> | <code>string</code> | Typescript artifacts output directory. |
143
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.projenrcTs">projenrcTs</a></code> | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`). |
144
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.projenrcTsOptions">projenrcTsOptions</a></code> | <code>projen.typescript.ProjenrcOptions</code> | Options for .projenrc.ts. |
145
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.sampleCode">sampleCode</a></code> | <code>boolean</code> | Generate one-time sample in `src/` and `test/` if there are no files there. |
146
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.srcdir">srcdir</a></code> | <code>string</code> | Typescript sources directory. |
147
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.testdir">testdir</a></code> | <code>string</code> | Jest tests directory. Tests files should be named `xxx.test.ts`. |
148
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom TSConfig. |
149
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
150
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name of the development tsconfig.json file. |
151
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
152
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.author">author</a></code> | <code>string</code> | The name of the library author. |
153
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.authorAddress">authorAddress</a></code> | <code>string</code> | Email or URL of the library author. |
154
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.repositoryUrl">repositoryUrl</a></code> | <code>string</code> | Git repository URL. |
155
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.compat">compat</a></code> | <code>boolean</code> | Automatically run API compatibility test against the latest version published to npm after compilation. |
156
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.compatIgnore">compatIgnore</a></code> | <code>string</code> | Name of the ignore file for API compatibility tests. |
157
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.compressAssembly">compressAssembly</a></code> | <code>boolean</code> | Emit a compressed version of the assembly. |
158
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.docgenFilePath">docgenFilePath</a></code> | <code>string</code> | File path for generated docs. |
159
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.dotnet">dotnet</a></code> | <code>projen.cdk.JsiiDotNetTarget</code> | *No description.* |
160
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.excludeTypescript">excludeTypescript</a></code> | <code>string[]</code> | Accepts a list of glob patterns. |
161
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.publishToGo">publishToGo</a></code> | <code>projen.cdk.JsiiGoTarget</code> | Publish Go bindings to a git repository. |
162
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.publishToMaven">publishToMaven</a></code> | <code>projen.cdk.JsiiJavaTarget</code> | Publish to maven. |
163
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.publishToNuget">publishToNuget</a></code> | <code>projen.cdk.JsiiDotNetTarget</code> | Publish to NuGet. |
164
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.publishToPypi">publishToPypi</a></code> | <code>projen.cdk.JsiiPythonTarget</code> | Publish to pypi. |
165
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.python">python</a></code> | <code>projen.cdk.JsiiPythonTarget</code> | *No description.* |
166
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.rootdir">rootdir</a></code> | <code>string</code> | *No description.* |
167
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.organizationName">organizationName</a></code> | <code>string</code> | *No description.* |
168
+
169
+ ---
170
+
171
+ ##### `name`<sup>Required</sup> <a name="name" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.name"></a>
172
+
173
+ ```typescript
174
+ public readonly name: string;
175
+ ```
176
+
177
+ - *Type:* string
178
+ - *Default:* $BASEDIR
179
+
180
+ This is the name of your project.
181
+
182
+ ---
183
+
184
+ ##### `commitGenerated`<sup>Optional</sup> <a name="commitGenerated" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.commitGenerated"></a>
185
+
186
+ ```typescript
187
+ public readonly commitGenerated: boolean;
188
+ ```
189
+
190
+ - *Type:* boolean
191
+ - *Default:* true
192
+
193
+ Whether to commit the managed files by default.
194
+
195
+ ---
196
+
197
+ ##### `logging`<sup>Optional</sup> <a name="logging" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.logging"></a>
198
+
199
+ ```typescript
200
+ public readonly logging: LoggerOptions;
201
+ ```
202
+
203
+ - *Type:* projen.LoggerOptions
204
+ - *Default:* {}
205
+
206
+ Configure logging options such as verbosity.
207
+
208
+ ---
209
+
210
+ ##### `outdir`<sup>Optional</sup> <a name="outdir" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.outdir"></a>
211
+
212
+ ```typescript
213
+ public readonly outdir: string;
214
+ ```
215
+
216
+ - *Type:* string
217
+ - *Default:* "."
218
+
219
+ The root directory of the project.
220
+
221
+ Relative to this directory, all files are synthesized.
222
+
223
+ If this project has a parent, this directory is relative to the parent
224
+ directory and it cannot be the same as the parent or any of it's other
225
+ sub-projects.
226
+
227
+ ---
228
+
229
+ ##### `parent`<sup>Optional</sup> <a name="parent" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.parent"></a>
230
+
231
+ ```typescript
232
+ public readonly parent: Project;
233
+ ```
234
+
235
+ - *Type:* projen.Project
236
+
237
+ The parent project, if this project is part of a bigger project.
238
+
239
+ ---
240
+
241
+ ##### `projenCommand`<sup>Optional</sup> <a name="projenCommand" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.projenCommand"></a>
242
+
243
+ ```typescript
244
+ public readonly projenCommand: string;
245
+ ```
246
+
247
+ - *Type:* string
248
+ - *Default:* "npx projen"
249
+
250
+ The shell command to use in order to run the projen CLI.
251
+
252
+ Can be used to customize in special environments.
253
+
254
+ ---
255
+
256
+ ##### `projenrcJson`<sup>Optional</sup> <a name="projenrcJson" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.projenrcJson"></a>
257
+
258
+ ```typescript
259
+ public readonly projenrcJson: boolean;
260
+ ```
261
+
262
+ - *Type:* boolean
263
+ - *Default:* false
264
+
265
+ Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
266
+
267
+ ---
268
+
269
+ ##### `projenrcJsonOptions`<sup>Optional</sup> <a name="projenrcJsonOptions" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.projenrcJsonOptions"></a>
270
+
271
+ ```typescript
272
+ public readonly projenrcJsonOptions: ProjenrcOptions;
273
+ ```
274
+
275
+ - *Type:* projen.ProjenrcOptions
276
+ - *Default:* default options
277
+
278
+ Options for .projenrc.json.
279
+
280
+ ---
281
+
282
+ ##### `renovatebot`<sup>Optional</sup> <a name="renovatebot" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.renovatebot"></a>
283
+
284
+ ```typescript
285
+ public readonly renovatebot: boolean;
286
+ ```
287
+
288
+ - *Type:* boolean
289
+ - *Default:* false
290
+
291
+ Use renovatebot to handle dependency upgrades.
292
+
293
+ ---
294
+
295
+ ##### `renovatebotOptions`<sup>Optional</sup> <a name="renovatebotOptions" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.renovatebotOptions"></a>
296
+
297
+ ```typescript
298
+ public readonly renovatebotOptions: RenovatebotOptions;
299
+ ```
300
+
301
+ - *Type:* projen.RenovatebotOptions
302
+ - *Default:* default options
303
+
304
+ Options for renovatebot.
305
+
306
+ ---
307
+
308
+ ##### `autoApproveOptions`<sup>Optional</sup> <a name="autoApproveOptions" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.autoApproveOptions"></a>
309
+
310
+ ```typescript
311
+ public readonly autoApproveOptions: AutoApproveOptions;
312
+ ```
313
+
314
+ - *Type:* projen.github.AutoApproveOptions
315
+ - *Default:* auto approve is disabled
316
+
317
+ Enable and configure the 'auto approve' workflow.
318
+
319
+ ---
320
+
321
+ ##### `autoMerge`<sup>Optional</sup> <a name="autoMerge" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.autoMerge"></a>
322
+
323
+ ```typescript
324
+ public readonly autoMerge: boolean;
325
+ ```
326
+
327
+ - *Type:* boolean
328
+ - *Default:* true
329
+
330
+ Enable automatic merging on GitHub.
331
+
332
+ Has no effect if `github.mergify`
333
+ is set to false.
334
+
335
+ ---
336
+
337
+ ##### `autoMergeOptions`<sup>Optional</sup> <a name="autoMergeOptions" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.autoMergeOptions"></a>
338
+
339
+ ```typescript
340
+ public readonly autoMergeOptions: AutoMergeOptions;
341
+ ```
342
+
343
+ - *Type:* projen.github.AutoMergeOptions
344
+ - *Default:* see defaults in `AutoMergeOptions`
345
+
346
+ Configure options for automatic merging on GitHub.
347
+
348
+ Has no effect if
349
+ `github.mergify` or `autoMerge` is set to false.
350
+
351
+ ---
352
+
353
+ ##### `clobber`<sup>Optional</sup> <a name="clobber" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.clobber"></a>
354
+
355
+ ```typescript
356
+ public readonly clobber: boolean;
357
+ ```
358
+
359
+ - *Type:* boolean
360
+ - *Default:* true
361
+
362
+ Add a `clobber` task which resets the repo to origin.
363
+
364
+ ---
365
+
366
+ ##### `devContainer`<sup>Optional</sup> <a name="devContainer" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.devContainer"></a>
367
+
368
+ ```typescript
369
+ public readonly devContainer: boolean;
370
+ ```
371
+
372
+ - *Type:* boolean
373
+ - *Default:* false
374
+
375
+ Add a VSCode development environment (used for GitHub Codespaces).
376
+
377
+ ---
378
+
379
+ ##### `github`<sup>Optional</sup> <a name="github" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.github"></a>
380
+
381
+ ```typescript
382
+ public readonly github: boolean;
383
+ ```
384
+
385
+ - *Type:* boolean
386
+ - *Default:* true
387
+
388
+ Enable GitHub integration.
389
+
390
+ Enabled by default for root projects. Disabled for non-root projects.
391
+
392
+ ---
393
+
394
+ ##### `githubOptions`<sup>Optional</sup> <a name="githubOptions" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.githubOptions"></a>
395
+
396
+ ```typescript
397
+ public readonly githubOptions: GitHubOptions;
398
+ ```
399
+
400
+ - *Type:* projen.github.GitHubOptions
401
+ - *Default:* see GitHubOptions
402
+
403
+ Options for GitHub integration.
404
+
405
+ ---
406
+
407
+ ##### `gitpod`<sup>Optional</sup> <a name="gitpod" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.gitpod"></a>
408
+
409
+ ```typescript
410
+ public readonly gitpod: boolean;
411
+ ```
412
+
413
+ - *Type:* boolean
414
+ - *Default:* false
415
+
416
+ Add a Gitpod development environment.
417
+
418
+ ---
419
+
420
+ ##### ~~`mergify`~~<sup>Optional</sup> <a name="mergify" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.mergify"></a>
421
+
422
+ - *Deprecated:* use `githubOptions.mergify` instead
423
+
424
+ ```typescript
425
+ public readonly mergify: boolean;
426
+ ```
427
+
428
+ - *Type:* boolean
429
+ - *Default:* true
430
+
431
+ Whether mergify should be enabled on this repository or not.
432
+
433
+ ---
434
+
435
+ ##### ~~`mergifyOptions`~~<sup>Optional</sup> <a name="mergifyOptions" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.mergifyOptions"></a>
436
+
437
+ - *Deprecated:* use `githubOptions.mergifyOptions` instead
438
+
439
+ ```typescript
440
+ public readonly mergifyOptions: MergifyOptions;
441
+ ```
442
+
443
+ - *Type:* projen.github.MergifyOptions
444
+ - *Default:* default options
445
+
446
+ Options for mergify.
447
+
448
+ ---
449
+
450
+ ##### ~~`projectType`~~<sup>Optional</sup> <a name="projectType" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.projectType"></a>
451
+
452
+ - *Deprecated:* no longer supported at the base project level
453
+
454
+ ```typescript
455
+ public readonly projectType: ProjectType;
456
+ ```
457
+
458
+ - *Type:* projen.ProjectType
459
+ - *Default:* ProjectType.UNKNOWN
460
+
461
+ Which type of project this is (library/app).
462
+
463
+ ---
464
+
465
+ ##### `projenCredentials`<sup>Optional</sup> <a name="projenCredentials" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.projenCredentials"></a>
466
+
467
+ ```typescript
468
+ public readonly projenCredentials: GithubCredentials;
469
+ ```
470
+
471
+ - *Type:* projen.github.GithubCredentials
472
+ - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN
473
+
474
+ Choose a method of providing GitHub API access for projen workflows.
475
+
476
+ ---
477
+
478
+ ##### ~~`projenTokenSecret`~~<sup>Optional</sup> <a name="projenTokenSecret" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.projenTokenSecret"></a>
479
+
480
+ - *Deprecated:* use `projenCredentials`
481
+
482
+ ```typescript
483
+ public readonly projenTokenSecret: string;
484
+ ```
485
+
486
+ - *Type:* string
487
+ - *Default:* "PROJEN_GITHUB_TOKEN"
488
+
489
+ The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
490
+
491
+ This token needs to have the `repo`, `workflows`
492
+ and `packages` scope.
493
+
494
+ ---
495
+
496
+ ##### `readme`<sup>Optional</sup> <a name="readme" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.readme"></a>
497
+
498
+ ```typescript
499
+ public readonly readme: SampleReadmeProps;
500
+ ```
501
+
502
+ - *Type:* projen.SampleReadmeProps
503
+ - *Default:* { filename: 'README.md', contents: '# replace this' }
504
+
505
+ The README setup.
506
+
507
+ ---
508
+
509
+ *Example*
510
+
511
+ ```typescript
512
+ "{ filename: 'readme.md', contents: '# title' }"
513
+ ```
514
+
515
+
516
+ ##### `stale`<sup>Optional</sup> <a name="stale" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.stale"></a>
517
+
518
+ ```typescript
519
+ public readonly stale: boolean;
520
+ ```
521
+
522
+ - *Type:* boolean
523
+ - *Default:* false
524
+
525
+ Auto-close of stale issues and pull request.
526
+
527
+ See `staleOptions` for options.
528
+
529
+ ---
530
+
531
+ ##### `staleOptions`<sup>Optional</sup> <a name="staleOptions" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.staleOptions"></a>
532
+
533
+ ```typescript
534
+ public readonly staleOptions: StaleOptions;
535
+ ```
536
+
537
+ - *Type:* projen.github.StaleOptions
538
+ - *Default:* see defaults in `StaleOptions`
539
+
540
+ Auto-close stale issues and pull requests.
541
+
542
+ To disable set `stale` to `false`.
543
+
544
+ ---
545
+
546
+ ##### `vscode`<sup>Optional</sup> <a name="vscode" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.vscode"></a>
547
+
548
+ ```typescript
549
+ public readonly vscode: boolean;
550
+ ```
551
+
552
+ - *Type:* boolean
553
+ - *Default:* true
554
+
555
+ Enable VSCode integration.
556
+
557
+ Enabled by default for root projects. Disabled for non-root projects.
558
+
559
+ ---
560
+
561
+ ##### `allowLibraryDependencies`<sup>Optional</sup> <a name="allowLibraryDependencies" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.allowLibraryDependencies"></a>
562
+
563
+ ```typescript
564
+ public readonly allowLibraryDependencies: boolean;
565
+ ```
566
+
567
+ - *Type:* boolean
568
+ - *Default:* true
569
+
570
+ Allow the project to include `peerDependencies` and `bundledDependencies`.
571
+
572
+ This is normally only allowed for libraries. For apps, there's no meaning
573
+ for specifying these.
574
+
575
+ ---
576
+
577
+ ##### `authorEmail`<sup>Optional</sup> <a name="authorEmail" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.authorEmail"></a>
578
+
579
+ ```typescript
580
+ public readonly authorEmail: string;
581
+ ```
582
+
583
+ - *Type:* string
584
+
585
+ Author's e-mail.
586
+
587
+ ---
588
+
589
+ ##### `authorName`<sup>Optional</sup> <a name="authorName" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.authorName"></a>
590
+
591
+ ```typescript
592
+ public readonly authorName: string;
593
+ ```
594
+
595
+ - *Type:* string
596
+
597
+ Author's name.
598
+
599
+ ---
600
+
601
+ ##### `authorOrganization`<sup>Optional</sup> <a name="authorOrganization" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.authorOrganization"></a>
602
+
603
+ ```typescript
604
+ public readonly authorOrganization: boolean;
605
+ ```
606
+
607
+ - *Type:* boolean
608
+
609
+ Is the author an organization.
610
+
611
+ ---
612
+
613
+ ##### `authorUrl`<sup>Optional</sup> <a name="authorUrl" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.authorUrl"></a>
614
+
615
+ ```typescript
616
+ public readonly authorUrl: string;
617
+ ```
618
+
619
+ - *Type:* string
620
+
621
+ Author's URL / Website.
622
+
623
+ ---
624
+
625
+ ##### `autoDetectBin`<sup>Optional</sup> <a name="autoDetectBin" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.autoDetectBin"></a>
626
+
627
+ ```typescript
628
+ public readonly autoDetectBin: boolean;
629
+ ```
630
+
631
+ - *Type:* boolean
632
+ - *Default:* true
633
+
634
+ Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
635
+
636
+ ---
637
+
638
+ ##### `bin`<sup>Optional</sup> <a name="bin" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.bin"></a>
639
+
640
+ ```typescript
641
+ public readonly bin: {[ key: string ]: string};
642
+ ```
643
+
644
+ - *Type:* {[ key: string ]: string}
645
+
646
+ Binary programs vended with your module.
647
+
648
+ You can use this option to add/customize how binaries are represented in
649
+ your `package.json`, but unless `autoDetectBin` is `false`, every
650
+ executable file under `bin` will automatically be added to this section.
651
+
652
+ ---
653
+
654
+ ##### `bugsEmail`<sup>Optional</sup> <a name="bugsEmail" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.bugsEmail"></a>
655
+
656
+ ```typescript
657
+ public readonly bugsEmail: string;
658
+ ```
659
+
660
+ - *Type:* string
661
+
662
+ The email address to which issues should be reported.
663
+
664
+ ---
665
+
666
+ ##### `bugsUrl`<sup>Optional</sup> <a name="bugsUrl" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.bugsUrl"></a>
667
+
668
+ ```typescript
669
+ public readonly bugsUrl: string;
670
+ ```
671
+
672
+ - *Type:* string
673
+
674
+ The url to your project's issue tracker.
675
+
676
+ ---
677
+
678
+ ##### `bundledDeps`<sup>Optional</sup> <a name="bundledDeps" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.bundledDeps"></a>
679
+
680
+ ```typescript
681
+ public readonly bundledDeps: string[];
682
+ ```
683
+
684
+ - *Type:* string[]
685
+
686
+ List of dependencies to bundle into this module.
687
+
688
+ These modules will be
689
+ added both to the `dependencies` section and `bundledDependencies` section of
690
+ your `package.json`.
691
+
692
+ The recommendation is to only specify the module name here (e.g.
693
+ `express`). This will behave similar to `yarn add` or `npm install` in the
694
+ sense that it will add the module as a dependency to your `package.json`
695
+ file with the latest version (`^`). You can specify semver requirements in
696
+ the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and
697
+ this will be what you `package.json` will eventually include.
698
+
699
+ ---
700
+
701
+ ##### `codeArtifactOptions`<sup>Optional</sup> <a name="codeArtifactOptions" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.codeArtifactOptions"></a>
702
+
703
+ ```typescript
704
+ public readonly codeArtifactOptions: CodeArtifactOptions;
705
+ ```
706
+
707
+ - *Type:* projen.javascript.CodeArtifactOptions
708
+ - *Default:* undefined
709
+
710
+ Options for npm packages using AWS CodeArtifact.
711
+
712
+ This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact
713
+
714
+ ---
715
+
716
+ ##### `deps`<sup>Optional</sup> <a name="deps" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.deps"></a>
717
+
718
+ ```typescript
719
+ public readonly deps: string[];
720
+ ```
721
+
722
+ - *Type:* string[]
723
+ - *Default:* []
724
+
725
+ Runtime dependencies of this module.
726
+
727
+ The recommendation is to only specify the module name here (e.g.
728
+ `express`). This will behave similar to `yarn add` or `npm install` in the
729
+ sense that it will add the module as a dependency to your `package.json`
730
+ file with the latest version (`^`). You can specify semver requirements in
731
+ the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and
732
+ this will be what you `package.json` will eventually include.
733
+
734
+ ---
735
+
736
+ *Example*
737
+
738
+ ```typescript
739
+ [ 'express', 'lodash', 'foo@^2' ]
740
+ ```
741
+
742
+
743
+ ##### `description`<sup>Optional</sup> <a name="description" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.description"></a>
744
+
745
+ ```typescript
746
+ public readonly description: string;
747
+ ```
748
+
749
+ - *Type:* string
750
+
751
+ The description is just a string that helps people understand the purpose of the package.
752
+
753
+ It can be used when searching for packages in a package manager as well.
754
+ See https://classic.yarnpkg.com/en/docs/package-json/#toc-description
755
+
756
+ ---
757
+
758
+ ##### `devDeps`<sup>Optional</sup> <a name="devDeps" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.devDeps"></a>
759
+
760
+ ```typescript
761
+ public readonly devDeps: string[];
762
+ ```
763
+
764
+ - *Type:* string[]
765
+ - *Default:* []
766
+
767
+ Build dependencies for this module.
768
+
769
+ These dependencies will only be
770
+ available in your build environment but will not be fetched when this
771
+ module is consumed.
772
+
773
+ The recommendation is to only specify the module name here (e.g.
774
+ `express`). This will behave similar to `yarn add` or `npm install` in the
775
+ sense that it will add the module as a dependency to your `package.json`
776
+ file with the latest version (`^`). You can specify semver requirements in
777
+ the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and
778
+ this will be what you `package.json` will eventually include.
779
+
780
+ ---
781
+
782
+ *Example*
783
+
784
+ ```typescript
785
+ [ 'typescript', '@types/express' ]
786
+ ```
787
+
788
+
789
+ ##### `entrypoint`<sup>Optional</sup> <a name="entrypoint" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.entrypoint"></a>
790
+
791
+ ```typescript
792
+ public readonly entrypoint: string;
793
+ ```
794
+
795
+ - *Type:* string
796
+ - *Default:* "lib/index.js"
797
+
798
+ Module entrypoint (`main` in `package.json`).
799
+
800
+ Set to an empty string to not include `main` in your package.json
801
+
802
+ ---
803
+
804
+ ##### `homepage`<sup>Optional</sup> <a name="homepage" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.homepage"></a>
805
+
806
+ ```typescript
807
+ public readonly homepage: string;
808
+ ```
809
+
810
+ - *Type:* string
811
+
812
+ Package's Homepage / Website.
813
+
814
+ ---
815
+
816
+ ##### `keywords`<sup>Optional</sup> <a name="keywords" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.keywords"></a>
817
+
818
+ ```typescript
819
+ public readonly keywords: string[];
820
+ ```
821
+
822
+ - *Type:* string[]
823
+
824
+ Keywords to include in `package.json`.
825
+
826
+ ---
827
+
828
+ ##### `license`<sup>Optional</sup> <a name="license" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.license"></a>
829
+
830
+ ```typescript
831
+ public readonly license: string;
832
+ ```
833
+
834
+ - *Type:* string
835
+ - *Default:* "Apache-2.0"
836
+
837
+ License's SPDX identifier.
838
+
839
+ See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses.
840
+ Use the `licensed` option if you want to no license to be specified.
841
+
842
+ ---
843
+
844
+ ##### `licensed`<sup>Optional</sup> <a name="licensed" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.licensed"></a>
845
+
846
+ ```typescript
847
+ public readonly licensed: boolean;
848
+ ```
849
+
850
+ - *Type:* boolean
851
+ - *Default:* true
852
+
853
+ Indicates if a license should be added.
854
+
855
+ ---
856
+
857
+ ##### `maxNodeVersion`<sup>Optional</sup> <a name="maxNodeVersion" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.maxNodeVersion"></a>
858
+
859
+ ```typescript
860
+ public readonly maxNodeVersion: string;
861
+ ```
862
+
863
+ - *Type:* string
864
+ - *Default:* no max
865
+
866
+ Minimum node.js version to require via `engines` (inclusive).
867
+
868
+ ---
869
+
870
+ ##### `minNodeVersion`<sup>Optional</sup> <a name="minNodeVersion" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.minNodeVersion"></a>
871
+
872
+ ```typescript
873
+ public readonly minNodeVersion: string;
874
+ ```
875
+
876
+ - *Type:* string
877
+ - *Default:* no "engines" specified
878
+
879
+ Minimum Node.js version to require via package.json `engines` (inclusive).
880
+
881
+ ---
882
+
883
+ ##### `npmAccess`<sup>Optional</sup> <a name="npmAccess" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.npmAccess"></a>
884
+
885
+ ```typescript
886
+ public readonly npmAccess: NpmAccess;
887
+ ```
888
+
889
+ - *Type:* projen.javascript.NpmAccess
890
+ - *Default:* for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
891
+
892
+ Access level of the npm package.
893
+
894
+ ---
895
+
896
+ ##### ~~`npmRegistry`~~<sup>Optional</sup> <a name="npmRegistry" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.npmRegistry"></a>
897
+
898
+ - *Deprecated:* use `npmRegistryUrl` instead
899
+
900
+ ```typescript
901
+ public readonly npmRegistry: string;
902
+ ```
903
+
904
+ - *Type:* string
905
+
906
+ The host name of the npm registry to publish to.
907
+
908
+ Cannot be set together with `npmRegistryUrl`.
909
+
910
+ ---
911
+
912
+ ##### `npmRegistryUrl`<sup>Optional</sup> <a name="npmRegistryUrl" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.npmRegistryUrl"></a>
913
+
914
+ ```typescript
915
+ public readonly npmRegistryUrl: string;
916
+ ```
917
+
918
+ - *Type:* string
919
+ - *Default:* "https://registry.npmjs.org"
920
+
921
+ The base URL of the npm package registry.
922
+
923
+ Must be a URL (e.g. start with "https://" or "http://")
924
+
925
+ ---
926
+
927
+ ##### `npmTokenSecret`<sup>Optional</sup> <a name="npmTokenSecret" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.npmTokenSecret"></a>
928
+
929
+ ```typescript
930
+ public readonly npmTokenSecret: string;
931
+ ```
932
+
933
+ - *Type:* string
934
+ - *Default:* "NPM_TOKEN"
935
+
936
+ GitHub secret which contains the NPM token to use when publishing packages.
937
+
938
+ ---
939
+
940
+ ##### `packageManager`<sup>Optional</sup> <a name="packageManager" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.packageManager"></a>
941
+
942
+ ```typescript
943
+ public readonly packageManager: NodePackageManager;
944
+ ```
945
+
946
+ - *Type:* projen.javascript.NodePackageManager
947
+ - *Default:* NodePackageManager.YARN
948
+
949
+ The Node Package Manager used to execute scripts.
950
+
951
+ ---
952
+
953
+ ##### `packageName`<sup>Optional</sup> <a name="packageName" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.packageName"></a>
954
+
955
+ ```typescript
956
+ public readonly packageName: string;
957
+ ```
958
+
959
+ - *Type:* string
960
+ - *Default:* defaults to project name
961
+
962
+ The "name" in package.json.
963
+
964
+ ---
965
+
966
+ ##### `peerDependencyOptions`<sup>Optional</sup> <a name="peerDependencyOptions" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.peerDependencyOptions"></a>
967
+
968
+ ```typescript
969
+ public readonly peerDependencyOptions: PeerDependencyOptions;
970
+ ```
971
+
972
+ - *Type:* projen.javascript.PeerDependencyOptions
973
+
974
+ Options for `peerDeps`.
975
+
976
+ ---
977
+
978
+ ##### `peerDeps`<sup>Optional</sup> <a name="peerDeps" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.peerDeps"></a>
979
+
980
+ ```typescript
981
+ public readonly peerDeps: string[];
982
+ ```
983
+
984
+ - *Type:* string[]
985
+ - *Default:* []
986
+
987
+ Peer dependencies for this module.
988
+
989
+ Dependencies listed here are required to
990
+ be installed (and satisfied) by the _consumer_ of this library. Using peer
991
+ dependencies allows you to ensure that only a single module of a certain
992
+ library exists in the `node_modules` tree of your consumers.
993
+
994
+ Note that prior to npm@7, peer dependencies are _not_ automatically
995
+ installed, which means that adding peer dependencies to a library will be a
996
+ breaking change for your customers.
997
+
998
+ Unless `peerDependencyOptions.pinnedDevDependency` is disabled (it is
999
+ enabled by default), projen will automatically add a dev dependency with a
1000
+ pinned version for each peer dependency. This will ensure that you build &
1001
+ test your module against the lowest peer version required.
1002
+
1003
+ ---
1004
+
1005
+ ##### `repository`<sup>Optional</sup> <a name="repository" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.repository"></a>
1006
+
1007
+ ```typescript
1008
+ public readonly repository: string;
1009
+ ```
1010
+
1011
+ - *Type:* string
1012
+
1013
+ The repository is the location where the actual code for your package lives.
1014
+
1015
+ See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository
1016
+
1017
+ ---
1018
+
1019
+ ##### `repositoryDirectory`<sup>Optional</sup> <a name="repositoryDirectory" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.repositoryDirectory"></a>
1020
+
1021
+ ```typescript
1022
+ public readonly repositoryDirectory: string;
1023
+ ```
1024
+
1025
+ - *Type:* string
1026
+
1027
+ If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives.
1028
+
1029
+ ---
1030
+
1031
+ ##### `scopedPackagesOptions`<sup>Optional</sup> <a name="scopedPackagesOptions" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.scopedPackagesOptions"></a>
1032
+
1033
+ ```typescript
1034
+ public readonly scopedPackagesOptions: ScopedPackagesOptions[];
1035
+ ```
1036
+
1037
+ - *Type:* projen.javascript.ScopedPackagesOptions[]
1038
+ - *Default:* fetch all scoped packages from the public npm registry
1039
+
1040
+ Options for privately hosted scoped packages.
1041
+
1042
+ ---
1043
+
1044
+ ##### `scripts`<sup>Optional</sup> <a name="scripts" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.scripts"></a>
1045
+
1046
+ ```typescript
1047
+ public readonly scripts: {[ key: string ]: string};
1048
+ ```
1049
+
1050
+ - *Type:* {[ key: string ]: string}
1051
+ - *Default:* {}
1052
+
1053
+ npm scripts to include.
1054
+
1055
+ If a script has the same name as a standard script,
1056
+ the standard script will be overwritten.
1057
+
1058
+ ---
1059
+
1060
+ ##### `stability`<sup>Optional</sup> <a name="stability" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.stability"></a>
1061
+
1062
+ ```typescript
1063
+ public readonly stability: string;
1064
+ ```
1065
+
1066
+ - *Type:* string
1067
+
1068
+ Package's Stability.
1069
+
1070
+ ---
1071
+
1072
+ ##### `jsiiReleaseVersion`<sup>Optional</sup> <a name="jsiiReleaseVersion" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.jsiiReleaseVersion"></a>
1073
+
1074
+ ```typescript
1075
+ public readonly jsiiReleaseVersion: string;
1076
+ ```
1077
+
1078
+ - *Type:* string
1079
+ - *Default:* "latest"
1080
+
1081
+ Version requirement of `publib` which is used to publish modules to npm.
1082
+
1083
+ ---
1084
+
1085
+ ##### `majorVersion`<sup>Optional</sup> <a name="majorVersion" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.majorVersion"></a>
1086
+
1087
+ ```typescript
1088
+ public readonly majorVersion: number;
1089
+ ```
1090
+
1091
+ - *Type:* number
1092
+ - *Default:* Major version is not enforced.
1093
+
1094
+ Major version to release from the default branch.
1095
+
1096
+ If this is specified, we bump the latest version of this major version line.
1097
+ If not specified, we bump the global latest version.
1098
+
1099
+ ---
1100
+
1101
+ ##### `minMajorVersion`<sup>Optional</sup> <a name="minMajorVersion" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.minMajorVersion"></a>
1102
+
1103
+ ```typescript
1104
+ public readonly minMajorVersion: number;
1105
+ ```
1106
+
1107
+ - *Type:* number
1108
+ - *Default:* No minimum version is being enforced
1109
+
1110
+ Minimal Major version to release.
1111
+
1112
+ This can be useful to set to 1, as breaking changes before the 1.x major
1113
+ release are not incrementing the major version number.
1114
+
1115
+ Can not be set together with `majorVersion`.
1116
+
1117
+ ---
1118
+
1119
+ ##### `npmDistTag`<sup>Optional</sup> <a name="npmDistTag" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.npmDistTag"></a>
1120
+
1121
+ ```typescript
1122
+ public readonly npmDistTag: string;
1123
+ ```
1124
+
1125
+ - *Type:* string
1126
+ - *Default:* "latest"
1127
+
1128
+ The npmDistTag to use when publishing from the default branch.
1129
+
1130
+ To set the npm dist-tag for release branches, set the `npmDistTag` property
1131
+ for each branch.
1132
+
1133
+ ---
1134
+
1135
+ ##### `postBuildSteps`<sup>Optional</sup> <a name="postBuildSteps" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.postBuildSteps"></a>
1136
+
1137
+ ```typescript
1138
+ public readonly postBuildSteps: JobStep[];
1139
+ ```
1140
+
1141
+ - *Type:* projen.github.workflows.JobStep[]
1142
+ - *Default:* []
1143
+
1144
+ Steps to execute after build as part of the release workflow.
1145
+
1146
+ ---
1147
+
1148
+ ##### `prerelease`<sup>Optional</sup> <a name="prerelease" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.prerelease"></a>
1149
+
1150
+ ```typescript
1151
+ public readonly prerelease: string;
1152
+ ```
1153
+
1154
+ - *Type:* string
1155
+ - *Default:* normal semantic versions
1156
+
1157
+ Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
1158
+
1159
+ ---
1160
+
1161
+ ##### `publishDryRun`<sup>Optional</sup> <a name="publishDryRun" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.publishDryRun"></a>
1162
+
1163
+ ```typescript
1164
+ public readonly publishDryRun: boolean;
1165
+ ```
1166
+
1167
+ - *Type:* boolean
1168
+ - *Default:* false
1169
+
1170
+ Instead of actually publishing to package managers, just print the publishing command.
1171
+
1172
+ ---
1173
+
1174
+ ##### `publishTasks`<sup>Optional</sup> <a name="publishTasks" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.publishTasks"></a>
1175
+
1176
+ ```typescript
1177
+ public readonly publishTasks: boolean;
1178
+ ```
1179
+
1180
+ - *Type:* boolean
1181
+ - *Default:* false
1182
+
1183
+ Define publishing tasks that can be executed manually as well as workflows.
1184
+
1185
+ Normally, publishing only happens within automated workflows. Enable this
1186
+ in order to create a publishing task for each publishing activity.
1187
+
1188
+ ---
1189
+
1190
+ ##### `releaseBranches`<sup>Optional</sup> <a name="releaseBranches" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.releaseBranches"></a>
1191
+
1192
+ ```typescript
1193
+ public readonly releaseBranches: {[ key: string ]: BranchOptions};
1194
+ ```
1195
+
1196
+ - *Type:* {[ key: string ]: projen.release.BranchOptions}
1197
+ - *Default:* no additional branches are used for release. you can use `addBranch()` to add additional branches.
1198
+
1199
+ Defines additional release branches.
1200
+
1201
+ A workflow will be created for each
1202
+ release branch which will publish releases from commits in this branch.
1203
+ Each release branch _must_ be assigned a major version number which is used
1204
+ to enforce that versions published from that branch always use that major
1205
+ version. If multiple branches are used, the `majorVersion` field must also
1206
+ be provided for the default branch.
1207
+
1208
+ ---
1209
+
1210
+ ##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.releaseEveryCommit"></a>
1211
+
1212
+ - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
1213
+
1214
+ ```typescript
1215
+ public readonly releaseEveryCommit: boolean;
1216
+ ```
1217
+
1218
+ - *Type:* boolean
1219
+ - *Default:* true
1220
+
1221
+ Automatically release new versions every commit to one of branches in `releaseBranches`.
1222
+
1223
+ ---
1224
+
1225
+ ##### `releaseFailureIssue`<sup>Optional</sup> <a name="releaseFailureIssue" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.releaseFailureIssue"></a>
1226
+
1227
+ ```typescript
1228
+ public readonly releaseFailureIssue: boolean;
1229
+ ```
1230
+
1231
+ - *Type:* boolean
1232
+ - *Default:* false
1233
+
1234
+ Create a github issue on every failed publishing task.
1235
+
1236
+ ---
1237
+
1238
+ ##### `releaseFailureIssueLabel`<sup>Optional</sup> <a name="releaseFailureIssueLabel" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.releaseFailureIssueLabel"></a>
1239
+
1240
+ ```typescript
1241
+ public readonly releaseFailureIssueLabel: string;
1242
+ ```
1243
+
1244
+ - *Type:* string
1245
+ - *Default:* "failed-release"
1246
+
1247
+ The label to apply to issues indicating publish failures.
1248
+
1249
+ Only applies if `releaseFailureIssue` is true.
1250
+
1251
+ ---
1252
+
1253
+ ##### ~~`releaseSchedule`~~<sup>Optional</sup> <a name="releaseSchedule" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.releaseSchedule"></a>
1254
+
1255
+ - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead
1256
+
1257
+ ```typescript
1258
+ public readonly releaseSchedule: string;
1259
+ ```
1260
+
1261
+ - *Type:* string
1262
+ - *Default:* no scheduled releases
1263
+
1264
+ CRON schedule to trigger new releases.
1265
+
1266
+ ---
1267
+
1268
+ ##### `releaseTagPrefix`<sup>Optional</sup> <a name="releaseTagPrefix" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.releaseTagPrefix"></a>
1269
+
1270
+ ```typescript
1271
+ public readonly releaseTagPrefix: string;
1272
+ ```
1273
+
1274
+ - *Type:* string
1275
+ - *Default:* "v"
1276
+
1277
+ Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
1278
+
1279
+ Note: this prefix is used to detect the latest tagged version
1280
+ when bumping, so if you change this on a project with an existing version
1281
+ history, you may need to manually tag your latest release
1282
+ with the new prefix.
1283
+
1284
+ ---
1285
+
1286
+ ##### `releaseTrigger`<sup>Optional</sup> <a name="releaseTrigger" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.releaseTrigger"></a>
1287
+
1288
+ ```typescript
1289
+ public readonly releaseTrigger: ReleaseTrigger;
1290
+ ```
1291
+
1292
+ - *Type:* projen.release.ReleaseTrigger
1293
+ - *Default:* Continuous releases (`ReleaseTrigger.continuous()`)
1294
+
1295
+ The release trigger to use.
1296
+
1297
+ ---
1298
+
1299
+ ##### `releaseWorkflowName`<sup>Optional</sup> <a name="releaseWorkflowName" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.releaseWorkflowName"></a>
1300
+
1301
+ ```typescript
1302
+ public readonly releaseWorkflowName: string;
1303
+ ```
1304
+
1305
+ - *Type:* string
1306
+ - *Default:* "Release"
1307
+
1308
+ The name of the default release workflow.
1309
+
1310
+ ---
1311
+
1312
+ ##### `releaseWorkflowSetupSteps`<sup>Optional</sup> <a name="releaseWorkflowSetupSteps" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.releaseWorkflowSetupSteps"></a>
1313
+
1314
+ ```typescript
1315
+ public readonly releaseWorkflowSetupSteps: JobStep[];
1316
+ ```
1317
+
1318
+ - *Type:* projen.github.workflows.JobStep[]
1319
+
1320
+ A set of workflow steps to execute in order to setup the workflow container.
1321
+
1322
+ ---
1323
+
1324
+ ##### `versionrcOptions`<sup>Optional</sup> <a name="versionrcOptions" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.versionrcOptions"></a>
1325
+
1326
+ ```typescript
1327
+ public readonly versionrcOptions: {[ key: string ]: any};
1328
+ ```
1329
+
1330
+ - *Type:* {[ key: string ]: any}
1331
+ - *Default:* standard configuration applicable for GitHub repositories
1332
+
1333
+ Custom configuration used when creating changelog with standard-version package.
1334
+
1335
+ Given values either append to default configuration or overwrite values in it.
1336
+
1337
+ ---
1338
+
1339
+ ##### `workflowContainerImage`<sup>Optional</sup> <a name="workflowContainerImage" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.workflowContainerImage"></a>
1340
+
1341
+ ```typescript
1342
+ public readonly workflowContainerImage: string;
1343
+ ```
1344
+
1345
+ - *Type:* string
1346
+ - *Default:* default image
1347
+
1348
+ Container image to use for GitHub workflows.
1349
+
1350
+ ---
1351
+
1352
+ ##### `workflowRunsOn`<sup>Optional</sup> <a name="workflowRunsOn" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.workflowRunsOn"></a>
1353
+
1354
+ ```typescript
1355
+ public readonly workflowRunsOn: string[];
1356
+ ```
1357
+
1358
+ - *Type:* string[]
1359
+ - *Default:* ["ubuntu-latest"]
1360
+
1361
+ Github Runner selection labels.
1362
+
1363
+ ---
1364
+
1365
+ ##### `defaultReleaseBranch`<sup>Required</sup> <a name="defaultReleaseBranch" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.defaultReleaseBranch"></a>
1366
+
1367
+ ```typescript
1368
+ public readonly defaultReleaseBranch: string;
1369
+ ```
1370
+
1371
+ - *Type:* string
1372
+ - *Default:* "main"
1373
+
1374
+ The name of the main release branch.
1375
+
1376
+ ---
1377
+
1378
+ ##### `artifactsDirectory`<sup>Optional</sup> <a name="artifactsDirectory" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.artifactsDirectory"></a>
1379
+
1380
+ ```typescript
1381
+ public readonly artifactsDirectory: string;
1382
+ ```
1383
+
1384
+ - *Type:* string
1385
+ - *Default:* "dist"
1386
+
1387
+ A directory which will contain build artifacts.
1388
+
1389
+ ---
1390
+
1391
+ ##### `autoApproveUpgrades`<sup>Optional</sup> <a name="autoApproveUpgrades" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.autoApproveUpgrades"></a>
1392
+
1393
+ ```typescript
1394
+ public readonly autoApproveUpgrades: boolean;
1395
+ ```
1396
+
1397
+ - *Type:* boolean
1398
+ - *Default:* true
1399
+
1400
+ Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
1401
+
1402
+ Throw if set to true but `autoApproveOptions` are not defined.
1403
+
1404
+ ---
1405
+
1406
+ ##### `buildWorkflow`<sup>Optional</sup> <a name="buildWorkflow" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.buildWorkflow"></a>
1407
+
1408
+ ```typescript
1409
+ public readonly buildWorkflow: boolean;
1410
+ ```
1411
+
1412
+ - *Type:* boolean
1413
+ - *Default:* true if not a subproject
1414
+
1415
+ Define a GitHub workflow for building PRs.
1416
+
1417
+ ---
1418
+
1419
+ ##### `buildWorkflowTriggers`<sup>Optional</sup> <a name="buildWorkflowTriggers" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.buildWorkflowTriggers"></a>
1420
+
1421
+ ```typescript
1422
+ public readonly buildWorkflowTriggers: Triggers;
1423
+ ```
1424
+
1425
+ - *Type:* projen.github.workflows.Triggers
1426
+ - *Default:* "{ pullRequest: {}, workflowDispatch: {} }"
1427
+
1428
+ Build workflow triggers.
1429
+
1430
+ ---
1431
+
1432
+ ##### `bundlerOptions`<sup>Optional</sup> <a name="bundlerOptions" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.bundlerOptions"></a>
1433
+
1434
+ ```typescript
1435
+ public readonly bundlerOptions: BundlerOptions;
1436
+ ```
1437
+
1438
+ - *Type:* projen.javascript.BundlerOptions
1439
+
1440
+ Options for `Bundler`.
1441
+
1442
+ ---
1443
+
1444
+ ##### `codeCov`<sup>Optional</sup> <a name="codeCov" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.codeCov"></a>
1445
+
1446
+ ```typescript
1447
+ public readonly codeCov: boolean;
1448
+ ```
1449
+
1450
+ - *Type:* boolean
1451
+ - *Default:* false
1452
+
1453
+ Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with @codeCovTokenSecret.
1454
+
1455
+ ---
1456
+
1457
+ ##### `codeCovTokenSecret`<sup>Optional</sup> <a name="codeCovTokenSecret" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.codeCovTokenSecret"></a>
1458
+
1459
+ ```typescript
1460
+ public readonly codeCovTokenSecret: string;
1461
+ ```
1462
+
1463
+ - *Type:* string
1464
+ - *Default:* if this option is not specified, only public repositories are supported
1465
+
1466
+ Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
1467
+
1468
+ ---
1469
+
1470
+ ##### `copyrightOwner`<sup>Optional</sup> <a name="copyrightOwner" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.copyrightOwner"></a>
1471
+
1472
+ ```typescript
1473
+ public readonly copyrightOwner: string;
1474
+ ```
1475
+
1476
+ - *Type:* string
1477
+ - *Default:* defaults to the value of authorName or "" if `authorName` is undefined.
1478
+
1479
+ License copyright owner.
1480
+
1481
+ ---
1482
+
1483
+ ##### `copyrightPeriod`<sup>Optional</sup> <a name="copyrightPeriod" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.copyrightPeriod"></a>
1484
+
1485
+ ```typescript
1486
+ public readonly copyrightPeriod: string;
1487
+ ```
1488
+
1489
+ - *Type:* string
1490
+ - *Default:* current year
1491
+
1492
+ The copyright years to put in the LICENSE file.
1493
+
1494
+ ---
1495
+
1496
+ ##### `dependabot`<sup>Optional</sup> <a name="dependabot" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.dependabot"></a>
1497
+
1498
+ ```typescript
1499
+ public readonly dependabot: boolean;
1500
+ ```
1501
+
1502
+ - *Type:* boolean
1503
+ - *Default:* false
1504
+
1505
+ Use dependabot to handle dependency upgrades.
1506
+
1507
+ Cannot be used in conjunction with `depsUpgrade`.
1508
+
1509
+ ---
1510
+
1511
+ ##### `dependabotOptions`<sup>Optional</sup> <a name="dependabotOptions" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.dependabotOptions"></a>
1512
+
1513
+ ```typescript
1514
+ public readonly dependabotOptions: DependabotOptions;
1515
+ ```
1516
+
1517
+ - *Type:* projen.github.DependabotOptions
1518
+ - *Default:* default options
1519
+
1520
+ Options for dependabot.
1521
+
1522
+ ---
1523
+
1524
+ ##### `depsUpgrade`<sup>Optional</sup> <a name="depsUpgrade" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.depsUpgrade"></a>
1525
+
1526
+ ```typescript
1527
+ public readonly depsUpgrade: boolean;
1528
+ ```
1529
+
1530
+ - *Type:* boolean
1531
+ - *Default:* true
1532
+
1533
+ Use github workflows to handle dependency upgrades.
1534
+
1535
+ Cannot be used in conjunction with `dependabot`.
1536
+
1537
+ ---
1538
+
1539
+ ##### `depsUpgradeOptions`<sup>Optional</sup> <a name="depsUpgradeOptions" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.depsUpgradeOptions"></a>
1540
+
1541
+ ```typescript
1542
+ public readonly depsUpgradeOptions: UpgradeDependenciesOptions;
1543
+ ```
1544
+
1545
+ - *Type:* projen.javascript.UpgradeDependenciesOptions
1546
+ - *Default:* default options
1547
+
1548
+ Options for `UpgradeDependencies`.
1549
+
1550
+ ---
1551
+
1552
+ ##### `gitignore`<sup>Optional</sup> <a name="gitignore" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.gitignore"></a>
1553
+
1554
+ ```typescript
1555
+ public readonly gitignore: string[];
1556
+ ```
1557
+
1558
+ - *Type:* string[]
1559
+
1560
+ Additional entries to .gitignore.
1561
+
1562
+ ---
1563
+
1564
+ ##### `jest`<sup>Optional</sup> <a name="jest" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.jest"></a>
1565
+
1566
+ ```typescript
1567
+ public readonly jest: boolean;
1568
+ ```
1569
+
1570
+ - *Type:* boolean
1571
+ - *Default:* true
1572
+
1573
+ Setup jest unit tests.
1574
+
1575
+ ---
1576
+
1577
+ ##### `jestOptions`<sup>Optional</sup> <a name="jestOptions" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.jestOptions"></a>
1578
+
1579
+ ```typescript
1580
+ public readonly jestOptions: JestOptions;
1581
+ ```
1582
+
1583
+ - *Type:* projen.javascript.JestOptions
1584
+ - *Default:* default options
1585
+
1586
+ Jest options.
1587
+
1588
+ ---
1589
+
1590
+ ##### `mutableBuild`<sup>Optional</sup> <a name="mutableBuild" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.mutableBuild"></a>
1591
+
1592
+ ```typescript
1593
+ public readonly mutableBuild: boolean;
1594
+ ```
1595
+
1596
+ - *Type:* boolean
1597
+ - *Default:* true
1598
+
1599
+ Automatically update files modified during builds to pull-request branches.
1600
+
1601
+ This means
1602
+ that any files synthesized by projen or e.g. test snapshots will always be up-to-date
1603
+ before a PR is merged.
1604
+
1605
+ Implies that PR builds do not have anti-tamper checks.
1606
+
1607
+ ---
1608
+
1609
+ ##### ~~`npmignore`~~<sup>Optional</sup> <a name="npmignore" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.npmignore"></a>
1610
+
1611
+ - *Deprecated:* - use `project.addPackageIgnore`
1612
+
1613
+ ```typescript
1614
+ public readonly npmignore: string[];
1615
+ ```
1616
+
1617
+ - *Type:* string[]
1618
+
1619
+ Additional entries to .npmignore.
1620
+
1621
+ ---
1622
+
1623
+ ##### `npmignoreEnabled`<sup>Optional</sup> <a name="npmignoreEnabled" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.npmignoreEnabled"></a>
1624
+
1625
+ ```typescript
1626
+ public readonly npmignoreEnabled: boolean;
1627
+ ```
1628
+
1629
+ - *Type:* boolean
1630
+ - *Default:* true
1631
+
1632
+ Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
1633
+
1634
+ ---
1635
+
1636
+ ##### `package`<sup>Optional</sup> <a name="package" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.package"></a>
1637
+
1638
+ ```typescript
1639
+ public readonly package: boolean;
1640
+ ```
1641
+
1642
+ - *Type:* boolean
1643
+ - *Default:* true
1644
+
1645
+ Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).
1646
+
1647
+ ---
1648
+
1649
+ ##### `prettier`<sup>Optional</sup> <a name="prettier" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.prettier"></a>
1650
+
1651
+ ```typescript
1652
+ public readonly prettier: boolean;
1653
+ ```
1654
+
1655
+ - *Type:* boolean
1656
+ - *Default:* false
1657
+
1658
+ Setup prettier.
1659
+
1660
+ ---
1661
+
1662
+ ##### `prettierOptions`<sup>Optional</sup> <a name="prettierOptions" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.prettierOptions"></a>
1663
+
1664
+ ```typescript
1665
+ public readonly prettierOptions: PrettierOptions;
1666
+ ```
1667
+
1668
+ - *Type:* projen.javascript.PrettierOptions
1669
+ - *Default:* default options
1670
+
1671
+ Prettier options.
1672
+
1673
+ ---
1674
+
1675
+ ##### `projenDevDependency`<sup>Optional</sup> <a name="projenDevDependency" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.projenDevDependency"></a>
1676
+
1677
+ ```typescript
1678
+ public readonly projenDevDependency: boolean;
1679
+ ```
1680
+
1681
+ - *Type:* boolean
1682
+ - *Default:* true
1683
+
1684
+ Indicates of "projen" should be installed as a devDependency.
1685
+
1686
+ ---
1687
+
1688
+ ##### `projenrcJs`<sup>Optional</sup> <a name="projenrcJs" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.projenrcJs"></a>
1689
+
1690
+ ```typescript
1691
+ public readonly projenrcJs: boolean;
1692
+ ```
1693
+
1694
+ - *Type:* boolean
1695
+ - *Default:* true if projenrcJson is false
1696
+
1697
+ Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.
1698
+
1699
+ ---
1700
+
1701
+ ##### `projenrcJsOptions`<sup>Optional</sup> <a name="projenrcJsOptions" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.projenrcJsOptions"></a>
1702
+
1703
+ ```typescript
1704
+ public readonly projenrcJsOptions: ProjenrcOptions;
1705
+ ```
1706
+
1707
+ - *Type:* projen.javascript.ProjenrcOptions
1708
+ - *Default:* default options
1709
+
1710
+ Options for .projenrc.js.
1711
+
1712
+ ---
1713
+
1714
+ ##### `projenVersion`<sup>Optional</sup> <a name="projenVersion" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.projenVersion"></a>
1715
+
1716
+ ```typescript
1717
+ public readonly projenVersion: string;
1718
+ ```
1719
+
1720
+ - *Type:* string
1721
+ - *Default:* Defaults to the latest version.
1722
+
1723
+ Version of projen to install.
1724
+
1725
+ ---
1726
+
1727
+ ##### `pullRequestTemplate`<sup>Optional</sup> <a name="pullRequestTemplate" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.pullRequestTemplate"></a>
1728
+
1729
+ ```typescript
1730
+ public readonly pullRequestTemplate: boolean;
1731
+ ```
1732
+
1733
+ - *Type:* boolean
1734
+ - *Default:* true
1735
+
1736
+ Include a GitHub pull request template.
1737
+
1738
+ ---
1739
+
1740
+ ##### `pullRequestTemplateContents`<sup>Optional</sup> <a name="pullRequestTemplateContents" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.pullRequestTemplateContents"></a>
1741
+
1742
+ ```typescript
1743
+ public readonly pullRequestTemplateContents: string[];
1744
+ ```
1745
+
1746
+ - *Type:* string[]
1747
+ - *Default:* default content
1748
+
1749
+ The contents of the pull request template.
1750
+
1751
+ ---
1752
+
1753
+ ##### `release`<sup>Optional</sup> <a name="release" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.release"></a>
1754
+
1755
+ ```typescript
1756
+ public readonly release: boolean;
1757
+ ```
1758
+
1759
+ - *Type:* boolean
1760
+ - *Default:* true (false for subprojects)
1761
+
1762
+ Add release management to this project.
1763
+
1764
+ ---
1765
+
1766
+ ##### `releaseToNpm`<sup>Optional</sup> <a name="releaseToNpm" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.releaseToNpm"></a>
1767
+
1768
+ ```typescript
1769
+ public readonly releaseToNpm: boolean;
1770
+ ```
1771
+
1772
+ - *Type:* boolean
1773
+ - *Default:* false
1774
+
1775
+ Automatically release to npm when new versions are introduced.
1776
+
1777
+ ---
1778
+
1779
+ ##### ~~`releaseWorkflow`~~<sup>Optional</sup> <a name="releaseWorkflow" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.releaseWorkflow"></a>
1780
+
1781
+ - *Deprecated:* see `release`.
1782
+
1783
+ ```typescript
1784
+ public readonly releaseWorkflow: boolean;
1785
+ ```
1786
+
1787
+ - *Type:* boolean
1788
+ - *Default:* true if not a subproject
1789
+
1790
+ DEPRECATED: renamed to `release`.
1791
+
1792
+ ---
1793
+
1794
+ ##### `workflowBootstrapSteps`<sup>Optional</sup> <a name="workflowBootstrapSteps" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.workflowBootstrapSteps"></a>
1795
+
1796
+ ```typescript
1797
+ public readonly workflowBootstrapSteps: JobStep[];
1798
+ ```
1799
+
1800
+ - *Type:* projen.github.workflows.JobStep[]
1801
+ - *Default:* "yarn install --frozen-lockfile && yarn projen"
1802
+
1803
+ Workflow steps to use in order to bootstrap this repo.
1804
+
1805
+ ---
1806
+
1807
+ ##### `workflowGitIdentity`<sup>Optional</sup> <a name="workflowGitIdentity" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.workflowGitIdentity"></a>
1808
+
1809
+ ```typescript
1810
+ public readonly workflowGitIdentity: GitIdentity;
1811
+ ```
1812
+
1813
+ - *Type:* projen.github.GitIdentity
1814
+ - *Default:* GitHub Actions
1815
+
1816
+ The git identity to use in workflows.
1817
+
1818
+ ---
1819
+
1820
+ ##### `workflowNodeVersion`<sup>Optional</sup> <a name="workflowNodeVersion" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.workflowNodeVersion"></a>
1821
+
1822
+ ```typescript
1823
+ public readonly workflowNodeVersion: string;
1824
+ ```
1825
+
1826
+ - *Type:* string
1827
+ - *Default:* same as `minNodeVersion`
1828
+
1829
+ The node version to use in GitHub workflows.
1830
+
1831
+ ---
1832
+
1833
+ ##### `disableTsconfig`<sup>Optional</sup> <a name="disableTsconfig" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.disableTsconfig"></a>
1834
+
1835
+ ```typescript
1836
+ public readonly disableTsconfig: boolean;
1837
+ ```
1838
+
1839
+ - *Type:* boolean
1840
+ - *Default:* false
1841
+
1842
+ Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
1843
+
1844
+ ---
1845
+
1846
+ ##### `docgen`<sup>Optional</sup> <a name="docgen" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.docgen"></a>
1847
+
1848
+ ```typescript
1849
+ public readonly docgen: boolean;
1850
+ ```
1851
+
1852
+ - *Type:* boolean
1853
+ - *Default:* false
1854
+
1855
+ Docgen by Typedoc.
1856
+
1857
+ ---
1858
+
1859
+ ##### `docsDirectory`<sup>Optional</sup> <a name="docsDirectory" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.docsDirectory"></a>
1860
+
1861
+ ```typescript
1862
+ public readonly docsDirectory: string;
1863
+ ```
1864
+
1865
+ - *Type:* string
1866
+ - *Default:* "docs"
1867
+
1868
+ Docs directory.
1869
+
1870
+ ---
1871
+
1872
+ ##### `entrypointTypes`<sup>Optional</sup> <a name="entrypointTypes" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.entrypointTypes"></a>
1873
+
1874
+ ```typescript
1875
+ public readonly entrypointTypes: string;
1876
+ ```
1877
+
1878
+ - *Type:* string
1879
+ - *Default:* .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
1880
+
1881
+ The .d.ts file that includes the type declarations for this module.
1882
+
1883
+ ---
1884
+
1885
+ ##### `eslint`<sup>Optional</sup> <a name="eslint" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.eslint"></a>
1886
+
1887
+ ```typescript
1888
+ public readonly eslint: boolean;
1889
+ ```
1890
+
1891
+ - *Type:* boolean
1892
+ - *Default:* true
1893
+
1894
+ Setup eslint.
1895
+
1896
+ ---
1897
+
1898
+ ##### `eslintOptions`<sup>Optional</sup> <a name="eslintOptions" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.eslintOptions"></a>
1899
+
1900
+ ```typescript
1901
+ public readonly eslintOptions: EslintOptions;
1902
+ ```
1903
+
1904
+ - *Type:* projen.javascript.EslintOptions
1905
+ - *Default:* opinionated default options
1906
+
1907
+ Eslint options.
1908
+
1909
+ ---
1910
+
1911
+ ##### `libdir`<sup>Optional</sup> <a name="libdir" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.libdir"></a>
1912
+
1913
+ ```typescript
1914
+ public readonly libdir: string;
1915
+ ```
1916
+
1917
+ - *Type:* string
1918
+ - *Default:* "lib"
1919
+
1920
+ Typescript artifacts output directory.
1921
+
1922
+ ---
1923
+
1924
+ ##### `projenrcTs`<sup>Optional</sup> <a name="projenrcTs" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.projenrcTs"></a>
1925
+
1926
+ ```typescript
1927
+ public readonly projenrcTs: boolean;
1928
+ ```
1929
+
1930
+ - *Type:* boolean
1931
+ - *Default:* false
1932
+
1933
+ Use TypeScript for your projenrc file (`.projenrc.ts`).
1934
+
1935
+ ---
1936
+
1937
+ ##### `projenrcTsOptions`<sup>Optional</sup> <a name="projenrcTsOptions" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.projenrcTsOptions"></a>
1938
+
1939
+ ```typescript
1940
+ public readonly projenrcTsOptions: ProjenrcOptions;
1941
+ ```
1942
+
1943
+ - *Type:* projen.typescript.ProjenrcOptions
1944
+
1945
+ Options for .projenrc.ts.
1946
+
1947
+ ---
1948
+
1949
+ ##### `sampleCode`<sup>Optional</sup> <a name="sampleCode" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.sampleCode"></a>
1950
+
1951
+ ```typescript
1952
+ public readonly sampleCode: boolean;
1953
+ ```
1954
+
1955
+ - *Type:* boolean
1956
+ - *Default:* true
1957
+
1958
+ Generate one-time sample in `src/` and `test/` if there are no files there.
1959
+
1960
+ ---
1961
+
1962
+ ##### `srcdir`<sup>Optional</sup> <a name="srcdir" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.srcdir"></a>
1963
+
1964
+ ```typescript
1965
+ public readonly srcdir: string;
1966
+ ```
1967
+
1968
+ - *Type:* string
1969
+ - *Default:* "src"
1970
+
1971
+ Typescript sources directory.
1972
+
1973
+ ---
1974
+
1975
+ ##### `testdir`<sup>Optional</sup> <a name="testdir" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.testdir"></a>
1976
+
1977
+ ```typescript
1978
+ public readonly testdir: string;
1979
+ ```
1980
+
1981
+ - *Type:* string
1982
+ - *Default:* "test"
1983
+
1984
+ Jest tests directory. Tests files should be named `xxx.test.ts`.
1985
+
1986
+ If this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`),
1987
+ then tests are going to be compiled into `lib/` and executed as javascript.
1988
+ If the test directory is outside of `src`, then we configure jest to
1989
+ compile the code in-memory.
1990
+
1991
+ ---
1992
+
1993
+ ##### `tsconfig`<sup>Optional</sup> <a name="tsconfig" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.tsconfig"></a>
1994
+
1995
+ ```typescript
1996
+ public readonly tsconfig: TypescriptConfigOptions;
1997
+ ```
1998
+
1999
+ - *Type:* projen.javascript.TypescriptConfigOptions
2000
+ - *Default:* default options
2001
+
2002
+ Custom TSConfig.
2003
+
2004
+ ---
2005
+
2006
+ ##### `tsconfigDev`<sup>Optional</sup> <a name="tsconfigDev" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.tsconfigDev"></a>
2007
+
2008
+ ```typescript
2009
+ public readonly tsconfigDev: TypescriptConfigOptions;
2010
+ ```
2011
+
2012
+ - *Type:* projen.javascript.TypescriptConfigOptions
2013
+ - *Default:* use the production tsconfig options
2014
+
2015
+ Custom tsconfig options for the development tsconfig.json file (used for testing).
2016
+
2017
+ ---
2018
+
2019
+ ##### `tsconfigDevFile`<sup>Optional</sup> <a name="tsconfigDevFile" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.tsconfigDevFile"></a>
2020
+
2021
+ ```typescript
2022
+ public readonly tsconfigDevFile: string;
2023
+ ```
2024
+
2025
+ - *Type:* string
2026
+ - *Default:* "tsconfig.dev.json"
2027
+
2028
+ The name of the development tsconfig.json file.
2029
+
2030
+ ---
2031
+
2032
+ ##### `typescriptVersion`<sup>Optional</sup> <a name="typescriptVersion" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.typescriptVersion"></a>
2033
+
2034
+ ```typescript
2035
+ public readonly typescriptVersion: string;
2036
+ ```
2037
+
2038
+ - *Type:* string
2039
+ - *Default:* "latest"
2040
+
2041
+ TypeScript version to use.
2042
+
2043
+ NOTE: Typescript is not semantically versioned and should remain on the
2044
+ same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`).
2045
+
2046
+ ---
2047
+
2048
+ ##### `author`<sup>Required</sup> <a name="author" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.author"></a>
2049
+
2050
+ ```typescript
2051
+ public readonly author: string;
2052
+ ```
2053
+
2054
+ - *Type:* string
2055
+ - *Default:* $GIT_USER_NAME
2056
+
2057
+ The name of the library author.
2058
+
2059
+ ---
2060
+
2061
+ ##### `authorAddress`<sup>Required</sup> <a name="authorAddress" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.authorAddress"></a>
2062
+
2063
+ ```typescript
2064
+ public readonly authorAddress: string;
2065
+ ```
2066
+
2067
+ - *Type:* string
2068
+ - *Default:* $GIT_USER_EMAIL
2069
+
2070
+ Email or URL of the library author.
2071
+
2072
+ ---
2073
+
2074
+ ##### `repositoryUrl`<sup>Required</sup> <a name="repositoryUrl" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.repositoryUrl"></a>
2075
+
2076
+ ```typescript
2077
+ public readonly repositoryUrl: string;
2078
+ ```
2079
+
2080
+ - *Type:* string
2081
+ - *Default:* $GIT_REMOTE
2082
+
2083
+ Git repository URL.
2084
+
2085
+ ---
2086
+
2087
+ ##### `compat`<sup>Optional</sup> <a name="compat" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.compat"></a>
2088
+
2089
+ ```typescript
2090
+ public readonly compat: boolean;
2091
+ ```
2092
+
2093
+ - *Type:* boolean
2094
+ - *Default:* false
2095
+
2096
+ Automatically run API compatibility test against the latest version published to npm after compilation.
2097
+
2098
+ You can manually run compatibility tests using `yarn compat` if this feature is disabled.
2099
+ - You can ignore compatibility failures by adding lines to a ".compatignore" file.
2100
+
2101
+ ---
2102
+
2103
+ ##### `compatIgnore`<sup>Optional</sup> <a name="compatIgnore" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.compatIgnore"></a>
2104
+
2105
+ ```typescript
2106
+ public readonly compatIgnore: string;
2107
+ ```
2108
+
2109
+ - *Type:* string
2110
+ - *Default:* ".compatignore"
2111
+
2112
+ Name of the ignore file for API compatibility tests.
2113
+
2114
+ ---
2115
+
2116
+ ##### `compressAssembly`<sup>Optional</sup> <a name="compressAssembly" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.compressAssembly"></a>
2117
+
2118
+ ```typescript
2119
+ public readonly compressAssembly: boolean;
2120
+ ```
2121
+
2122
+ - *Type:* boolean
2123
+ - *Default:* false
2124
+
2125
+ Emit a compressed version of the assembly.
2126
+
2127
+ ---
2128
+
2129
+ ##### `docgenFilePath`<sup>Optional</sup> <a name="docgenFilePath" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.docgenFilePath"></a>
2130
+
2131
+ ```typescript
2132
+ public readonly docgenFilePath: string;
2133
+ ```
2134
+
2135
+ - *Type:* string
2136
+ - *Default:* "API.md"
2137
+
2138
+ File path for generated docs.
2139
+
2140
+ ---
2141
+
2142
+ ##### ~~`dotnet`~~<sup>Optional</sup> <a name="dotnet" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.dotnet"></a>
2143
+
2144
+ - *Deprecated:* use `publishToNuget`
2145
+
2146
+ ```typescript
2147
+ public readonly dotnet: JsiiDotNetTarget;
2148
+ ```
2149
+
2150
+ - *Type:* projen.cdk.JsiiDotNetTarget
2151
+
2152
+ ---
2153
+
2154
+ ##### `excludeTypescript`<sup>Optional</sup> <a name="excludeTypescript" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.excludeTypescript"></a>
2155
+
2156
+ ```typescript
2157
+ public readonly excludeTypescript: string[];
2158
+ ```
2159
+
2160
+ - *Type:* string[]
2161
+
2162
+ Accepts a list of glob patterns.
2163
+
2164
+ Files matching any of those patterns will be excluded from the TypeScript compiler input.
2165
+
2166
+ By default, jsii will include all *.ts files (except .d.ts files) in the TypeScript compiler input.
2167
+ This can be problematic for example when the package's build or test procedure generates .ts files
2168
+ that cannot be compiled with jsii's compiler settings.
2169
+
2170
+ ---
2171
+
2172
+ ##### `publishToGo`<sup>Optional</sup> <a name="publishToGo" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.publishToGo"></a>
2173
+
2174
+ ```typescript
2175
+ public readonly publishToGo: JsiiGoTarget;
2176
+ ```
2177
+
2178
+ - *Type:* projen.cdk.JsiiGoTarget
2179
+ - *Default:* no publishing
2180
+
2181
+ Publish Go bindings to a git repository.
2182
+
2183
+ ---
2184
+
2185
+ ##### `publishToMaven`<sup>Optional</sup> <a name="publishToMaven" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.publishToMaven"></a>
2186
+
2187
+ ```typescript
2188
+ public readonly publishToMaven: JsiiJavaTarget;
2189
+ ```
2190
+
2191
+ - *Type:* projen.cdk.JsiiJavaTarget
2192
+ - *Default:* no publishing
2193
+
2194
+ Publish to maven.
2195
+
2196
+ ---
2197
+
2198
+ ##### `publishToNuget`<sup>Optional</sup> <a name="publishToNuget" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.publishToNuget"></a>
2199
+
2200
+ ```typescript
2201
+ public readonly publishToNuget: JsiiDotNetTarget;
2202
+ ```
2203
+
2204
+ - *Type:* projen.cdk.JsiiDotNetTarget
2205
+ - *Default:* no publishing
2206
+
2207
+ Publish to NuGet.
2208
+
2209
+ ---
2210
+
2211
+ ##### `publishToPypi`<sup>Optional</sup> <a name="publishToPypi" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.publishToPypi"></a>
2212
+
2213
+ ```typescript
2214
+ public readonly publishToPypi: JsiiPythonTarget;
2215
+ ```
2216
+
2217
+ - *Type:* projen.cdk.JsiiPythonTarget
2218
+ - *Default:* no publishing
2219
+
2220
+ Publish to pypi.
2221
+
2222
+ ---
2223
+
2224
+ ##### ~~`python`~~<sup>Optional</sup> <a name="python" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.python"></a>
2225
+
2226
+ - *Deprecated:* use `publishToPyPi`
2227
+
2228
+ ```typescript
2229
+ public readonly python: JsiiPythonTarget;
2230
+ ```
2231
+
2232
+ - *Type:* projen.cdk.JsiiPythonTarget
2233
+
2234
+ ---
2235
+
2236
+ ##### `rootdir`<sup>Optional</sup> <a name="rootdir" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.rootdir"></a>
2237
+
2238
+ ```typescript
2239
+ public readonly rootdir: string;
2240
+ ```
2241
+
2242
+ - *Type:* string
2243
+ - *Default:* "."
2244
+
2245
+ ---
2246
+
2247
+ ##### `organizationName`<sup>Required</sup> <a name="organizationName" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.organizationName"></a>
2248
+
2249
+ ```typescript
2250
+ public readonly organizationName: string;
2251
+ ```
2252
+
2253
+ - *Type:* string
2254
+
2255
+ ---
2256
+
2257
+ ## Classes <a name="Classes" id="Classes"></a>
2258
+
2259
+ ### SkepOrganizationProject <a name="SkepOrganizationProject" id="@skeptools/skep-organization-project.SkepOrganizationProject"></a>
2260
+
2261
+ #### Initializers <a name="Initializers" id="@skeptools/skep-organization-project.SkepOrganizationProject.Initializer"></a>
2262
+
2263
+ ```typescript
2264
+ import { SkepOrganizationProject } from '@skeptools/skep-organization-project'
2265
+
2266
+ new SkepOrganizationProject(options: SkepOrganizationProjectOptions)
2267
+ ```
2268
+
2269
+ | **Name** | **Type** | **Description** |
2270
+ | --- | --- | --- |
2271
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.Initializer.parameter.options">options</a></code> | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions">SkepOrganizationProjectOptions</a></code> | *No description.* |
2272
+
2273
+ ---
2274
+
2275
+ ##### `options`<sup>Required</sup> <a name="options" id="@skeptools/skep-organization-project.SkepOrganizationProject.Initializer.parameter.options"></a>
2276
+
2277
+ - *Type:* <a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions">SkepOrganizationProjectOptions</a>
2278
+
2279
+ ---
2280
+
2281
+ #### Methods <a name="Methods" id="Methods"></a>
2282
+
2283
+ | **Name** | **Description** |
2284
+ | --- | --- |
2285
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.addExcludeFromCleanup">addExcludeFromCleanup</a></code> | Exclude the matching files from pre-synth cleanup. |
2286
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
2287
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.addPackageIgnore">addPackageIgnore</a></code> | Exclude these files from the bundled package. |
2288
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.addTask">addTask</a></code> | Adds a new task to this project. |
2289
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.addTip">addTip</a></code> | Prints a "tip" message during synthesis. |
2290
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.annotateGenerated">annotateGenerated</a></code> | Marks the provided file(s) as being generated. |
2291
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.postSynthesize">postSynthesize</a></code> | Called after all components are synthesized. |
2292
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.preSynthesize">preSynthesize</a></code> | Called before all components are synthesized. |
2293
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.removeTask">removeTask</a></code> | Removes a task from a project. |
2294
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.runTaskCommand">runTaskCommand</a></code> | Returns the shell command to execute in order to run a task. |
2295
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.synth">synth</a></code> | Synthesize all project files into `outdir`. |
2296
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.tryFindFile">tryFindFile</a></code> | Finds a file at the specified relative path within this project and all its subprojects. |
2297
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.tryFindJsonFile">tryFindJsonFile</a></code> | Finds a json file by name. |
2298
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.tryFindObjectFile">tryFindObjectFile</a></code> | Finds an object file (like JsonFile, YamlFile, etc.) by name. |
2299
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.tryRemoveFile">tryRemoveFile</a></code> | Finds a file at the specified relative path within this project and removes it. |
2300
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.addBins">addBins</a></code> | *No description.* |
2301
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.addBundledDeps">addBundledDeps</a></code> | Defines bundled dependencies. |
2302
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.addCompileCommand">addCompileCommand</a></code> | DEPRECATED. |
2303
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.addDeps">addDeps</a></code> | Defines normal dependencies. |
2304
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.addDevDeps">addDevDeps</a></code> | Defines development/test dependencies. |
2305
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.addFields">addFields</a></code> | Directly set fields in `package.json`. |
2306
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.addKeywords">addKeywords</a></code> | Adds keywords to package.json (deduplicated). |
2307
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.addPeerDeps">addPeerDeps</a></code> | Defines peer dependencies. |
2308
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.addTestCommand">addTestCommand</a></code> | DEPRECATED. |
2309
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.hasScript">hasScript</a></code> | Indicates if a script by the name name is defined. |
2310
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.removeScript">removeScript</a></code> | Removes the npm script (always successful). |
2311
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.renderWorkflowSetup">renderWorkflowSetup</a></code> | Returns the set of workflow steps which should be executed to bootstrap a workflow. |
2312
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.setScript">setScript</a></code> | Replaces the contents of an npm package.json script. |
2313
+
2314
+ ---
2315
+
2316
+ ##### `addExcludeFromCleanup` <a name="addExcludeFromCleanup" id="@skeptools/skep-organization-project.SkepOrganizationProject.addExcludeFromCleanup"></a>
2317
+
2318
+ ```typescript
2319
+ public addExcludeFromCleanup(globs: string): void
2320
+ ```
2321
+
2322
+ Exclude the matching files from pre-synth cleanup.
2323
+
2324
+ Can be used when, for example, some
2325
+ source files include the projen marker and we don't want them to be erased during synth.
2326
+
2327
+ ###### `globs`<sup>Required</sup> <a name="globs" id="@skeptools/skep-organization-project.SkepOrganizationProject.addExcludeFromCleanup.parameter.globs"></a>
2328
+
2329
+ - *Type:* string
2330
+
2331
+ The glob patterns to match.
2332
+
2333
+ ---
2334
+
2335
+ ##### `addGitIgnore` <a name="addGitIgnore" id="@skeptools/skep-organization-project.SkepOrganizationProject.addGitIgnore"></a>
2336
+
2337
+ ```typescript
2338
+ public addGitIgnore(pattern: string): void
2339
+ ```
2340
+
2341
+ Adds a .gitignore pattern.
2342
+
2343
+ ###### `pattern`<sup>Required</sup> <a name="pattern" id="@skeptools/skep-organization-project.SkepOrganizationProject.addGitIgnore.parameter.pattern"></a>
2344
+
2345
+ - *Type:* string
2346
+
2347
+ The glob pattern to ignore.
2348
+
2349
+ ---
2350
+
2351
+ ##### `addPackageIgnore` <a name="addPackageIgnore" id="@skeptools/skep-organization-project.SkepOrganizationProject.addPackageIgnore"></a>
2352
+
2353
+ ```typescript
2354
+ public addPackageIgnore(pattern: string): void
2355
+ ```
2356
+
2357
+ Exclude these files from the bundled package.
2358
+
2359
+ Implemented by project types based on the
2360
+ packaging mechanism. For example, `NodeProject` delegates this to `.npmignore`.
2361
+
2362
+ ###### `pattern`<sup>Required</sup> <a name="pattern" id="@skeptools/skep-organization-project.SkepOrganizationProject.addPackageIgnore.parameter.pattern"></a>
2363
+
2364
+ - *Type:* string
2365
+
2366
+ ---
2367
+
2368
+ ##### `addTask` <a name="addTask" id="@skeptools/skep-organization-project.SkepOrganizationProject.addTask"></a>
2369
+
2370
+ ```typescript
2371
+ public addTask(name: string, props?: TaskOptions): Task
2372
+ ```
2373
+
2374
+ Adds a new task to this project.
2375
+
2376
+ This will fail if the project already has
2377
+ a task with this name.
2378
+
2379
+ ###### `name`<sup>Required</sup> <a name="name" id="@skeptools/skep-organization-project.SkepOrganizationProject.addTask.parameter.name"></a>
2380
+
2381
+ - *Type:* string
2382
+
2383
+ The task name to add.
2384
+
2385
+ ---
2386
+
2387
+ ###### `props`<sup>Optional</sup> <a name="props" id="@skeptools/skep-organization-project.SkepOrganizationProject.addTask.parameter.props"></a>
2388
+
2389
+ - *Type:* projen.TaskOptions
2390
+
2391
+ Task properties.
2392
+
2393
+ ---
2394
+
2395
+ ##### ~~`addTip`~~ <a name="addTip" id="@skeptools/skep-organization-project.SkepOrganizationProject.addTip"></a>
2396
+
2397
+ ```typescript
2398
+ public addTip(message: string): void
2399
+ ```
2400
+
2401
+ Prints a "tip" message during synthesis.
2402
+
2403
+ ###### `message`<sup>Required</sup> <a name="message" id="@skeptools/skep-organization-project.SkepOrganizationProject.addTip.parameter.message"></a>
2404
+
2405
+ - *Type:* string
2406
+
2407
+ The message.
2408
+
2409
+ ---
2410
+
2411
+ ##### `annotateGenerated` <a name="annotateGenerated" id="@skeptools/skep-organization-project.SkepOrganizationProject.annotateGenerated"></a>
2412
+
2413
+ ```typescript
2414
+ public annotateGenerated(glob: string): void
2415
+ ```
2416
+
2417
+ Marks the provided file(s) as being generated.
2418
+
2419
+ This is achieved using the
2420
+ github-linguist attributes. Generated files do not count against the
2421
+ repository statistics and language breakdown.
2422
+
2423
+ > [https://github.com/github/linguist/blob/master/docs/overrides.md](https://github.com/github/linguist/blob/master/docs/overrides.md)
2424
+
2425
+ ###### `glob`<sup>Required</sup> <a name="glob" id="@skeptools/skep-organization-project.SkepOrganizationProject.annotateGenerated.parameter.glob"></a>
2426
+
2427
+ - *Type:* string
2428
+
2429
+ the glob pattern to match (could be a file path).
2430
+
2431
+ ---
2432
+
2433
+ ##### `postSynthesize` <a name="postSynthesize" id="@skeptools/skep-organization-project.SkepOrganizationProject.postSynthesize"></a>
2434
+
2435
+ ```typescript
2436
+ public postSynthesize(): void
2437
+ ```
2438
+
2439
+ Called after all components are synthesized.
2440
+
2441
+ Order is *not* guaranteed.
2442
+
2443
+ ##### `preSynthesize` <a name="preSynthesize" id="@skeptools/skep-organization-project.SkepOrganizationProject.preSynthesize"></a>
2444
+
2445
+ ```typescript
2446
+ public preSynthesize(): void
2447
+ ```
2448
+
2449
+ Called before all components are synthesized.
2450
+
2451
+ ##### `removeTask` <a name="removeTask" id="@skeptools/skep-organization-project.SkepOrganizationProject.removeTask"></a>
2452
+
2453
+ ```typescript
2454
+ public removeTask(name: string): Task
2455
+ ```
2456
+
2457
+ Removes a task from a project.
2458
+
2459
+ ###### `name`<sup>Required</sup> <a name="name" id="@skeptools/skep-organization-project.SkepOrganizationProject.removeTask.parameter.name"></a>
2460
+
2461
+ - *Type:* string
2462
+
2463
+ The name of the task to remove.
2464
+
2465
+ ---
2466
+
2467
+ ##### `runTaskCommand` <a name="runTaskCommand" id="@skeptools/skep-organization-project.SkepOrganizationProject.runTaskCommand"></a>
2468
+
2469
+ ```typescript
2470
+ public runTaskCommand(task: Task): string
2471
+ ```
2472
+
2473
+ Returns the shell command to execute in order to run a task.
2474
+
2475
+ This will
2476
+ typically be `npx projen TASK`.
2477
+
2478
+ ###### `task`<sup>Required</sup> <a name="task" id="@skeptools/skep-organization-project.SkepOrganizationProject.runTaskCommand.parameter.task"></a>
2479
+
2480
+ - *Type:* projen.Task
2481
+
2482
+ The task for which the command is required.
2483
+
2484
+ ---
2485
+
2486
+ ##### `synth` <a name="synth" id="@skeptools/skep-organization-project.SkepOrganizationProject.synth"></a>
2487
+
2488
+ ```typescript
2489
+ public synth(): void
2490
+ ```
2491
+
2492
+ Synthesize all project files into `outdir`.
2493
+
2494
+ 1. Call "this.preSynthesize()"
2495
+ 2. Delete all generated files
2496
+ 3. Synthesize all sub-projects
2497
+ 4. Synthesize all components of this project
2498
+ 5. Call "postSynthesize()" for all components of this project
2499
+ 6. Call "this.postSynthesize()"
2500
+
2501
+ ##### `tryFindFile` <a name="tryFindFile" id="@skeptools/skep-organization-project.SkepOrganizationProject.tryFindFile"></a>
2502
+
2503
+ ```typescript
2504
+ public tryFindFile(filePath: string): FileBase
2505
+ ```
2506
+
2507
+ Finds a file at the specified relative path within this project and all its subprojects.
2508
+
2509
+ ###### `filePath`<sup>Required</sup> <a name="filePath" id="@skeptools/skep-organization-project.SkepOrganizationProject.tryFindFile.parameter.filePath"></a>
2510
+
2511
+ - *Type:* string
2512
+
2513
+ The file path.
2514
+
2515
+ If this path is relative, it will be resolved
2516
+ from the root of _this_ project.
2517
+
2518
+ ---
2519
+
2520
+ ##### ~~`tryFindJsonFile`~~ <a name="tryFindJsonFile" id="@skeptools/skep-organization-project.SkepOrganizationProject.tryFindJsonFile"></a>
2521
+
2522
+ ```typescript
2523
+ public tryFindJsonFile(filePath: string): JsonFile
2524
+ ```
2525
+
2526
+ Finds a json file by name.
2527
+
2528
+ ###### `filePath`<sup>Required</sup> <a name="filePath" id="@skeptools/skep-organization-project.SkepOrganizationProject.tryFindJsonFile.parameter.filePath"></a>
2529
+
2530
+ - *Type:* string
2531
+
2532
+ The file path.
2533
+
2534
+ ---
2535
+
2536
+ ##### `tryFindObjectFile` <a name="tryFindObjectFile" id="@skeptools/skep-organization-project.SkepOrganizationProject.tryFindObjectFile"></a>
2537
+
2538
+ ```typescript
2539
+ public tryFindObjectFile(filePath: string): ObjectFile
2540
+ ```
2541
+
2542
+ Finds an object file (like JsonFile, YamlFile, etc.) by name.
2543
+
2544
+ ###### `filePath`<sup>Required</sup> <a name="filePath" id="@skeptools/skep-organization-project.SkepOrganizationProject.tryFindObjectFile.parameter.filePath"></a>
2545
+
2546
+ - *Type:* string
2547
+
2548
+ The file path.
2549
+
2550
+ ---
2551
+
2552
+ ##### `tryRemoveFile` <a name="tryRemoveFile" id="@skeptools/skep-organization-project.SkepOrganizationProject.tryRemoveFile"></a>
2553
+
2554
+ ```typescript
2555
+ public tryRemoveFile(filePath: string): FileBase
2556
+ ```
2557
+
2558
+ Finds a file at the specified relative path within this project and removes it.
2559
+
2560
+ ###### `filePath`<sup>Required</sup> <a name="filePath" id="@skeptools/skep-organization-project.SkepOrganizationProject.tryRemoveFile.parameter.filePath"></a>
2561
+
2562
+ - *Type:* string
2563
+
2564
+ The file path.
2565
+
2566
+ If this path is relative, it will be
2567
+ resolved from the root of _this_ project.
2568
+
2569
+ ---
2570
+
2571
+ ##### `addBins` <a name="addBins" id="@skeptools/skep-organization-project.SkepOrganizationProject.addBins"></a>
2572
+
2573
+ ```typescript
2574
+ public addBins(bins: {[ key: string ]: string}): void
2575
+ ```
2576
+
2577
+ ###### `bins`<sup>Required</sup> <a name="bins" id="@skeptools/skep-organization-project.SkepOrganizationProject.addBins.parameter.bins"></a>
2578
+
2579
+ - *Type:* {[ key: string ]: string}
2580
+
2581
+ ---
2582
+
2583
+ ##### `addBundledDeps` <a name="addBundledDeps" id="@skeptools/skep-organization-project.SkepOrganizationProject.addBundledDeps"></a>
2584
+
2585
+ ```typescript
2586
+ public addBundledDeps(deps: string): void
2587
+ ```
2588
+
2589
+ Defines bundled dependencies.
2590
+
2591
+ Bundled dependencies will be added as normal dependencies as well as to the
2592
+ `bundledDependencies` section of your `package.json`.
2593
+
2594
+ ###### `deps`<sup>Required</sup> <a name="deps" id="@skeptools/skep-organization-project.SkepOrganizationProject.addBundledDeps.parameter.deps"></a>
2595
+
2596
+ - *Type:* string
2597
+
2598
+ Names modules to install.
2599
+
2600
+ By default, the the dependency will
2601
+ be installed in the next `npx projen` run and the version will be recorded
2602
+ in your `package.json` file. You can upgrade manually or using `yarn
2603
+ add/upgrade`. If you wish to specify a version range use this syntax:
2604
+ `module@^7`.
2605
+
2606
+ ---
2607
+
2608
+ ##### ~~`addCompileCommand`~~ <a name="addCompileCommand" id="@skeptools/skep-organization-project.SkepOrganizationProject.addCompileCommand"></a>
2609
+
2610
+ ```typescript
2611
+ public addCompileCommand(commands: string): void
2612
+ ```
2613
+
2614
+ DEPRECATED.
2615
+
2616
+ ###### `commands`<sup>Required</sup> <a name="commands" id="@skeptools/skep-organization-project.SkepOrganizationProject.addCompileCommand.parameter.commands"></a>
2617
+
2618
+ - *Type:* string
2619
+
2620
+ ---
2621
+
2622
+ ##### `addDeps` <a name="addDeps" id="@skeptools/skep-organization-project.SkepOrganizationProject.addDeps"></a>
2623
+
2624
+ ```typescript
2625
+ public addDeps(deps: string): void
2626
+ ```
2627
+
2628
+ Defines normal dependencies.
2629
+
2630
+ ###### `deps`<sup>Required</sup> <a name="deps" id="@skeptools/skep-organization-project.SkepOrganizationProject.addDeps.parameter.deps"></a>
2631
+
2632
+ - *Type:* string
2633
+
2634
+ Names modules to install.
2635
+
2636
+ By default, the the dependency will
2637
+ be installed in the next `npx projen` run and the version will be recorded
2638
+ in your `package.json` file. You can upgrade manually or using `yarn
2639
+ add/upgrade`. If you wish to specify a version range use this syntax:
2640
+ `module@^7`.
2641
+
2642
+ ---
2643
+
2644
+ ##### `addDevDeps` <a name="addDevDeps" id="@skeptools/skep-organization-project.SkepOrganizationProject.addDevDeps"></a>
2645
+
2646
+ ```typescript
2647
+ public addDevDeps(deps: string): void
2648
+ ```
2649
+
2650
+ Defines development/test dependencies.
2651
+
2652
+ ###### `deps`<sup>Required</sup> <a name="deps" id="@skeptools/skep-organization-project.SkepOrganizationProject.addDevDeps.parameter.deps"></a>
2653
+
2654
+ - *Type:* string
2655
+
2656
+ Names modules to install.
2657
+
2658
+ By default, the the dependency will
2659
+ be installed in the next `npx projen` run and the version will be recorded
2660
+ in your `package.json` file. You can upgrade manually or using `yarn
2661
+ add/upgrade`. If you wish to specify a version range use this syntax:
2662
+ `module@^7`.
2663
+
2664
+ ---
2665
+
2666
+ ##### `addFields` <a name="addFields" id="@skeptools/skep-organization-project.SkepOrganizationProject.addFields"></a>
2667
+
2668
+ ```typescript
2669
+ public addFields(fields: {[ key: string ]: any}): void
2670
+ ```
2671
+
2672
+ Directly set fields in `package.json`.
2673
+
2674
+ ###### `fields`<sup>Required</sup> <a name="fields" id="@skeptools/skep-organization-project.SkepOrganizationProject.addFields.parameter.fields"></a>
2675
+
2676
+ - *Type:* {[ key: string ]: any}
2677
+
2678
+ The fields to set.
2679
+
2680
+ ---
2681
+
2682
+ ##### `addKeywords` <a name="addKeywords" id="@skeptools/skep-organization-project.SkepOrganizationProject.addKeywords"></a>
2683
+
2684
+ ```typescript
2685
+ public addKeywords(keywords: string): void
2686
+ ```
2687
+
2688
+ Adds keywords to package.json (deduplicated).
2689
+
2690
+ ###### `keywords`<sup>Required</sup> <a name="keywords" id="@skeptools/skep-organization-project.SkepOrganizationProject.addKeywords.parameter.keywords"></a>
2691
+
2692
+ - *Type:* string
2693
+
2694
+ The keywords to add.
2695
+
2696
+ ---
2697
+
2698
+ ##### `addPeerDeps` <a name="addPeerDeps" id="@skeptools/skep-organization-project.SkepOrganizationProject.addPeerDeps"></a>
2699
+
2700
+ ```typescript
2701
+ public addPeerDeps(deps: string): void
2702
+ ```
2703
+
2704
+ Defines peer dependencies.
2705
+
2706
+ When adding peer dependencies, a devDependency will also be added on the
2707
+ pinned version of the declared peer. This will ensure that you are testing
2708
+ your code against the minimum version required from your consumers.
2709
+
2710
+ ###### `deps`<sup>Required</sup> <a name="deps" id="@skeptools/skep-organization-project.SkepOrganizationProject.addPeerDeps.parameter.deps"></a>
2711
+
2712
+ - *Type:* string
2713
+
2714
+ Names modules to install.
2715
+
2716
+ By default, the the dependency will
2717
+ be installed in the next `npx projen` run and the version will be recorded
2718
+ in your `package.json` file. You can upgrade manually or using `yarn
2719
+ add/upgrade`. If you wish to specify a version range use this syntax:
2720
+ `module@^7`.
2721
+
2722
+ ---
2723
+
2724
+ ##### ~~`addTestCommand`~~ <a name="addTestCommand" id="@skeptools/skep-organization-project.SkepOrganizationProject.addTestCommand"></a>
2725
+
2726
+ ```typescript
2727
+ public addTestCommand(commands: string): void
2728
+ ```
2729
+
2730
+ DEPRECATED.
2731
+
2732
+ ###### `commands`<sup>Required</sup> <a name="commands" id="@skeptools/skep-organization-project.SkepOrganizationProject.addTestCommand.parameter.commands"></a>
2733
+
2734
+ - *Type:* string
2735
+
2736
+ ---
2737
+
2738
+ ##### `hasScript` <a name="hasScript" id="@skeptools/skep-organization-project.SkepOrganizationProject.hasScript"></a>
2739
+
2740
+ ```typescript
2741
+ public hasScript(name: string): boolean
2742
+ ```
2743
+
2744
+ Indicates if a script by the name name is defined.
2745
+
2746
+ ###### `name`<sup>Required</sup> <a name="name" id="@skeptools/skep-organization-project.SkepOrganizationProject.hasScript.parameter.name"></a>
2747
+
2748
+ - *Type:* string
2749
+
2750
+ The name of the script.
2751
+
2752
+ ---
2753
+
2754
+ ##### `removeScript` <a name="removeScript" id="@skeptools/skep-organization-project.SkepOrganizationProject.removeScript"></a>
2755
+
2756
+ ```typescript
2757
+ public removeScript(name: string): void
2758
+ ```
2759
+
2760
+ Removes the npm script (always successful).
2761
+
2762
+ ###### `name`<sup>Required</sup> <a name="name" id="@skeptools/skep-organization-project.SkepOrganizationProject.removeScript.parameter.name"></a>
2763
+
2764
+ - *Type:* string
2765
+
2766
+ The name of the script.
2767
+
2768
+ ---
2769
+
2770
+ ##### `renderWorkflowSetup` <a name="renderWorkflowSetup" id="@skeptools/skep-organization-project.SkepOrganizationProject.renderWorkflowSetup"></a>
2771
+
2772
+ ```typescript
2773
+ public renderWorkflowSetup(options?: RenderWorkflowSetupOptions): JobStep[]
2774
+ ```
2775
+
2776
+ Returns the set of workflow steps which should be executed to bootstrap a workflow.
2777
+
2778
+ ###### `options`<sup>Optional</sup> <a name="options" id="@skeptools/skep-organization-project.SkepOrganizationProject.renderWorkflowSetup.parameter.options"></a>
2779
+
2780
+ - *Type:* projen.javascript.RenderWorkflowSetupOptions
2781
+
2782
+ Options.
2783
+
2784
+ ---
2785
+
2786
+ ##### `setScript` <a name="setScript" id="@skeptools/skep-organization-project.SkepOrganizationProject.setScript"></a>
2787
+
2788
+ ```typescript
2789
+ public setScript(name: string, command: string): void
2790
+ ```
2791
+
2792
+ Replaces the contents of an npm package.json script.
2793
+
2794
+ ###### `name`<sup>Required</sup> <a name="name" id="@skeptools/skep-organization-project.SkepOrganizationProject.setScript.parameter.name"></a>
2795
+
2796
+ - *Type:* string
2797
+
2798
+ The script name.
2799
+
2800
+ ---
2801
+
2802
+ ###### `command`<sup>Required</sup> <a name="command" id="@skeptools/skep-organization-project.SkepOrganizationProject.setScript.parameter.command"></a>
2803
+
2804
+ - *Type:* string
2805
+
2806
+ The command to execute.
2807
+
2808
+ ---
2809
+
2810
+
2811
+ #### Properties <a name="Properties" id="Properties"></a>
2812
+
2813
+ | **Name** | **Type** | **Description** |
2814
+ | --- | --- | --- |
2815
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.buildTask">buildTask</a></code> | <code>projen.Task</code> | *No description.* |
2816
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
2817
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.compileTask">compileTask</a></code> | <code>projen.Task</code> | *No description.* |
2818
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.components">components</a></code> | <code>projen.Component[]</code> | Returns all the components within this project. |
2819
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.deps">deps</a></code> | <code>projen.Dependencies</code> | Project dependencies. |
2820
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.ejected">ejected</a></code> | <code>boolean</code> | Whether or not the project is being ejected. |
2821
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.files">files</a></code> | <code>projen.FileBase[]</code> | All files in this project. |
2822
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.gitattributes">gitattributes</a></code> | <code>projen.GitAttributesFile</code> | The .gitattributes file for this repository. |
2823
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.gitignore">gitignore</a></code> | <code>projen.IgnoreFile</code> | .gitignore. |
2824
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.logger">logger</a></code> | <code>projen.Logger</code> | Logging utilities. |
2825
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.name">name</a></code> | <code>string</code> | Project name. |
2826
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.outdir">outdir</a></code> | <code>string</code> | Absolute output directory of this project. |
2827
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.packageTask">packageTask</a></code> | <code>projen.Task</code> | *No description.* |
2828
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.postCompileTask">postCompileTask</a></code> | <code>projen.Task</code> | *No description.* |
2829
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.preCompileTask">preCompileTask</a></code> | <code>projen.Task</code> | *No description.* |
2830
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.projectBuild">projectBuild</a></code> | <code>projen.ProjectBuild</code> | Manages the build process of the project. |
2831
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.projenCommand">projenCommand</a></code> | <code>string</code> | The command to use in order to run the projen CLI. |
2832
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.root">root</a></code> | <code>projen.Project</code> | The root project. |
2833
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.tasks">tasks</a></code> | <code>projen.Tasks</code> | Project tasks. |
2834
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.testTask">testTask</a></code> | <code>projen.Task</code> | *No description.* |
2835
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.defaultTask">defaultTask</a></code> | <code>projen.Task</code> | This is the "default" task, the one that executes "projen". |
2836
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.initProject">initProject</a></code> | <code>projen.InitProject</code> | The options used when this project is bootstrapped via `projen new`. |
2837
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.parent">parent</a></code> | <code>projen.Project</code> | A parent project. |
2838
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | *No description.* |
2839
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.autoApprove">autoApprove</a></code> | <code>projen.github.AutoApprove</code> | Auto approve set up for this project. |
2840
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.devContainer">devContainer</a></code> | <code>projen.vscode.DevContainer</code> | Access for .devcontainer.json (used for GitHub Codespaces). |
2841
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.github">github</a></code> | <code>projen.github.GitHub</code> | Access all github components. |
2842
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.gitpod">gitpod</a></code> | <code>projen.Gitpod</code> | Access for Gitpod. |
2843
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.vscode">vscode</a></code> | <code>projen.vscode.VsCode</code> | Access all VSCode components. |
2844
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | *No description.* |
2845
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | The build output directory. |
2846
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.artifactsJavascriptDirectory">artifactsJavascriptDirectory</a></code> | <code>string</code> | The location of the npm tarball after build (`${artifactsDirectory}/js`). |
2847
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.bundler">bundler</a></code> | <code>projen.javascript.Bundler</code> | *No description.* |
2848
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.entrypoint">entrypoint</a></code> | <code>string</code> | *No description.* |
2849
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.manifest">manifest</a></code> | <code>any</code> | *No description.* |
2850
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.package">package</a></code> | <code>projen.javascript.NodePackage</code> | API for managing the node package. |
2851
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The package manager to use. |
2852
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.runScriptCommand">runScriptCommand</a></code> | <code>string</code> | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). |
2853
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.autoMerge">autoMerge</a></code> | <code>projen.github.AutoMerge</code> | Component that sets up mergify for merging approved pull requests. |
2854
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.buildWorkflow">buildWorkflow</a></code> | <code>projen.build.BuildWorkflow</code> | The PR build GitHub workflow. |
2855
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.buildWorkflowJobId">buildWorkflowJobId</a></code> | <code>string</code> | The job ID of the build workflow. |
2856
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.jest">jest</a></code> | <code>projen.javascript.Jest</code> | The Jest configuration (if enabled). |
2857
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.maxNodeVersion">maxNodeVersion</a></code> | <code>string</code> | Maximum node version required by this pacakge. |
2858
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | Minimum node.js version required by this package. |
2859
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.npmignore">npmignore</a></code> | <code>projen.IgnoreFile</code> | The .npmignore file. |
2860
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.prettier">prettier</a></code> | <code>projen.javascript.Prettier</code> | *No description.* |
2861
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.publisher">publisher</a></code> | <code>projen.release.Publisher</code> | Package publisher. |
2862
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.release">release</a></code> | <code>projen.release.Release</code> | Release management. |
2863
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.upgradeWorkflow">upgradeWorkflow</a></code> | <code>projen.javascript.UpgradeDependencies</code> | The upgrade workflow. |
2864
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | *No description.* |
2865
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.libdir">libdir</a></code> | <code>string</code> | The directory in which compiled .js files reside. |
2866
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.srcdir">srcdir</a></code> | <code>string</code> | The directory in which the .ts sources reside. |
2867
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.testdir">testdir</a></code> | <code>string</code> | The directory in which tests reside. |
2868
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfig</code> | A typescript configuration file which covers all files (sources, tests, projen). |
2869
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.watchTask">watchTask</a></code> | <code>projen.Task</code> | The "watch" task. |
2870
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.docgen">docgen</a></code> | <code>boolean</code> | *No description.* |
2871
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.eslint">eslint</a></code> | <code>projen.javascript.Eslint</code> | *No description.* |
2872
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfig</code> | *No description.* |
2873
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.tsconfigEslint">tsconfigEslint</a></code> | <code>projen.javascript.TypescriptConfig</code> | *No description.* |
2874
+
2875
+ ---
2876
+
2877
+ ##### `buildTask`<sup>Required</sup> <a name="buildTask" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.buildTask"></a>
2878
+
2879
+ ```typescript
2880
+ public readonly buildTask: Task;
2881
+ ```
2882
+
2883
+ - *Type:* projen.Task
2884
+
2885
+ ---
2886
+
2887
+ ##### `commitGenerated`<sup>Required</sup> <a name="commitGenerated" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.commitGenerated"></a>
2888
+
2889
+ ```typescript
2890
+ public readonly commitGenerated: boolean;
2891
+ ```
2892
+
2893
+ - *Type:* boolean
2894
+
2895
+ Whether to commit the managed files by default.
2896
+
2897
+ ---
2898
+
2899
+ ##### `compileTask`<sup>Required</sup> <a name="compileTask" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.compileTask"></a>
2900
+
2901
+ ```typescript
2902
+ public readonly compileTask: Task;
2903
+ ```
2904
+
2905
+ - *Type:* projen.Task
2906
+
2907
+ ---
2908
+
2909
+ ##### `components`<sup>Required</sup> <a name="components" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.components"></a>
2910
+
2911
+ ```typescript
2912
+ public readonly components: Component[];
2913
+ ```
2914
+
2915
+ - *Type:* projen.Component[]
2916
+
2917
+ Returns all the components within this project.
2918
+
2919
+ ---
2920
+
2921
+ ##### `deps`<sup>Required</sup> <a name="deps" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.deps"></a>
2922
+
2923
+ ```typescript
2924
+ public readonly deps: Dependencies;
2925
+ ```
2926
+
2927
+ - *Type:* projen.Dependencies
2928
+
2929
+ Project dependencies.
2930
+
2931
+ ---
2932
+
2933
+ ##### `ejected`<sup>Required</sup> <a name="ejected" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.ejected"></a>
2934
+
2935
+ ```typescript
2936
+ public readonly ejected: boolean;
2937
+ ```
2938
+
2939
+ - *Type:* boolean
2940
+
2941
+ Whether or not the project is being ejected.
2942
+
2943
+ ---
2944
+
2945
+ ##### `files`<sup>Required</sup> <a name="files" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.files"></a>
2946
+
2947
+ ```typescript
2948
+ public readonly files: FileBase[];
2949
+ ```
2950
+
2951
+ - *Type:* projen.FileBase[]
2952
+
2953
+ All files in this project.
2954
+
2955
+ ---
2956
+
2957
+ ##### `gitattributes`<sup>Required</sup> <a name="gitattributes" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.gitattributes"></a>
2958
+
2959
+ ```typescript
2960
+ public readonly gitattributes: GitAttributesFile;
2961
+ ```
2962
+
2963
+ - *Type:* projen.GitAttributesFile
2964
+
2965
+ The .gitattributes file for this repository.
2966
+
2967
+ ---
2968
+
2969
+ ##### `gitignore`<sup>Required</sup> <a name="gitignore" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.gitignore"></a>
2970
+
2971
+ ```typescript
2972
+ public readonly gitignore: IgnoreFile;
2973
+ ```
2974
+
2975
+ - *Type:* projen.IgnoreFile
2976
+
2977
+ .gitignore.
2978
+
2979
+ ---
2980
+
2981
+ ##### `logger`<sup>Required</sup> <a name="logger" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.logger"></a>
2982
+
2983
+ ```typescript
2984
+ public readonly logger: Logger;
2985
+ ```
2986
+
2987
+ - *Type:* projen.Logger
2988
+
2989
+ Logging utilities.
2990
+
2991
+ ---
2992
+
2993
+ ##### `name`<sup>Required</sup> <a name="name" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.name"></a>
2994
+
2995
+ ```typescript
2996
+ public readonly name: string;
2997
+ ```
2998
+
2999
+ - *Type:* string
3000
+
3001
+ Project name.
3002
+
3003
+ ---
3004
+
3005
+ ##### `outdir`<sup>Required</sup> <a name="outdir" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.outdir"></a>
3006
+
3007
+ ```typescript
3008
+ public readonly outdir: string;
3009
+ ```
3010
+
3011
+ - *Type:* string
3012
+
3013
+ Absolute output directory of this project.
3014
+
3015
+ ---
3016
+
3017
+ ##### `packageTask`<sup>Required</sup> <a name="packageTask" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.packageTask"></a>
3018
+
3019
+ ```typescript
3020
+ public readonly packageTask: Task;
3021
+ ```
3022
+
3023
+ - *Type:* projen.Task
3024
+
3025
+ ---
3026
+
3027
+ ##### `postCompileTask`<sup>Required</sup> <a name="postCompileTask" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.postCompileTask"></a>
3028
+
3029
+ ```typescript
3030
+ public readonly postCompileTask: Task;
3031
+ ```
3032
+
3033
+ - *Type:* projen.Task
3034
+
3035
+ ---
3036
+
3037
+ ##### `preCompileTask`<sup>Required</sup> <a name="preCompileTask" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.preCompileTask"></a>
3038
+
3039
+ ```typescript
3040
+ public readonly preCompileTask: Task;
3041
+ ```
3042
+
3043
+ - *Type:* projen.Task
3044
+
3045
+ ---
3046
+
3047
+ ##### `projectBuild`<sup>Required</sup> <a name="projectBuild" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.projectBuild"></a>
3048
+
3049
+ ```typescript
3050
+ public readonly projectBuild: ProjectBuild;
3051
+ ```
3052
+
3053
+ - *Type:* projen.ProjectBuild
3054
+
3055
+ Manages the build process of the project.
3056
+
3057
+ ---
3058
+
3059
+ ##### `projenCommand`<sup>Required</sup> <a name="projenCommand" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.projenCommand"></a>
3060
+
3061
+ ```typescript
3062
+ public readonly projenCommand: string;
3063
+ ```
3064
+
3065
+ - *Type:* string
3066
+
3067
+ The command to use in order to run the projen CLI.
3068
+
3069
+ ---
3070
+
3071
+ ##### `root`<sup>Required</sup> <a name="root" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.root"></a>
3072
+
3073
+ ```typescript
3074
+ public readonly root: Project;
3075
+ ```
3076
+
3077
+ - *Type:* projen.Project
3078
+
3079
+ The root project.
3080
+
3081
+ ---
3082
+
3083
+ ##### `tasks`<sup>Required</sup> <a name="tasks" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.tasks"></a>
3084
+
3085
+ ```typescript
3086
+ public readonly tasks: Tasks;
3087
+ ```
3088
+
3089
+ - *Type:* projen.Tasks
3090
+
3091
+ Project tasks.
3092
+
3093
+ ---
3094
+
3095
+ ##### `testTask`<sup>Required</sup> <a name="testTask" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.testTask"></a>
3096
+
3097
+ ```typescript
3098
+ public readonly testTask: Task;
3099
+ ```
3100
+
3101
+ - *Type:* projen.Task
3102
+
3103
+ ---
3104
+
3105
+ ##### `defaultTask`<sup>Optional</sup> <a name="defaultTask" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.defaultTask"></a>
3106
+
3107
+ ```typescript
3108
+ public readonly defaultTask: Task;
3109
+ ```
3110
+
3111
+ - *Type:* projen.Task
3112
+
3113
+ This is the "default" task, the one that executes "projen".
3114
+
3115
+ Undefined if
3116
+ the project is being ejected.
3117
+
3118
+ ---
3119
+
3120
+ ##### `initProject`<sup>Optional</sup> <a name="initProject" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.initProject"></a>
3121
+
3122
+ ```typescript
3123
+ public readonly initProject: InitProject;
3124
+ ```
3125
+
3126
+ - *Type:* projen.InitProject
3127
+
3128
+ The options used when this project is bootstrapped via `projen new`.
3129
+
3130
+ It
3131
+ includes the original set of options passed to the CLI and also the JSII
3132
+ FQN of the project type.
3133
+
3134
+ ---
3135
+
3136
+ ##### `parent`<sup>Optional</sup> <a name="parent" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.parent"></a>
3137
+
3138
+ ```typescript
3139
+ public readonly parent: Project;
3140
+ ```
3141
+
3142
+ - *Type:* projen.Project
3143
+
3144
+ A parent project.
3145
+
3146
+ If undefined, this is the root project.
3147
+
3148
+ ---
3149
+
3150
+ ##### `projectType`<sup>Required</sup> <a name="projectType" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.projectType"></a>
3151
+
3152
+ ```typescript
3153
+ public readonly projectType: ProjectType;
3154
+ ```
3155
+
3156
+ - *Type:* projen.ProjectType
3157
+
3158
+ ---
3159
+
3160
+ ##### `autoApprove`<sup>Optional</sup> <a name="autoApprove" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.autoApprove"></a>
3161
+
3162
+ ```typescript
3163
+ public readonly autoApprove: AutoApprove;
3164
+ ```
3165
+
3166
+ - *Type:* projen.github.AutoApprove
3167
+
3168
+ Auto approve set up for this project.
3169
+
3170
+ ---
3171
+
3172
+ ##### `devContainer`<sup>Optional</sup> <a name="devContainer" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.devContainer"></a>
3173
+
3174
+ ```typescript
3175
+ public readonly devContainer: DevContainer;
3176
+ ```
3177
+
3178
+ - *Type:* projen.vscode.DevContainer
3179
+
3180
+ Access for .devcontainer.json (used for GitHub Codespaces).
3181
+
3182
+ This will be `undefined` if devContainer boolean is false
3183
+
3184
+ ---
3185
+
3186
+ ##### `github`<sup>Optional</sup> <a name="github" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.github"></a>
3187
+
3188
+ ```typescript
3189
+ public readonly github: GitHub;
3190
+ ```
3191
+
3192
+ - *Type:* projen.github.GitHub
3193
+
3194
+ Access all github components.
3195
+
3196
+ This will be `undefined` for subprojects.
3197
+
3198
+ ---
3199
+
3200
+ ##### `gitpod`<sup>Optional</sup> <a name="gitpod" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.gitpod"></a>
3201
+
3202
+ ```typescript
3203
+ public readonly gitpod: Gitpod;
3204
+ ```
3205
+
3206
+ - *Type:* projen.Gitpod
3207
+
3208
+ Access for Gitpod.
3209
+
3210
+ This will be `undefined` if gitpod boolean is false
3211
+
3212
+ ---
3213
+
3214
+ ##### `vscode`<sup>Optional</sup> <a name="vscode" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.vscode"></a>
3215
+
3216
+ ```typescript
3217
+ public readonly vscode: VsCode;
3218
+ ```
3219
+
3220
+ - *Type:* projen.vscode.VsCode
3221
+
3222
+ Access all VSCode components.
3223
+
3224
+ This will be `undefined` for subprojects.
3225
+
3226
+ ---
3227
+
3228
+ ##### ~~`allowLibraryDependencies`~~<sup>Required</sup> <a name="allowLibraryDependencies" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.allowLibraryDependencies"></a>
3229
+
3230
+ - *Deprecated:* use `package.allowLibraryDependencies`
3231
+
3232
+ ```typescript
3233
+ public readonly allowLibraryDependencies: boolean;
3234
+ ```
3235
+
3236
+ - *Type:* boolean
3237
+
3238
+ ---
3239
+
3240
+ ##### `artifactsDirectory`<sup>Required</sup> <a name="artifactsDirectory" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.artifactsDirectory"></a>
3241
+
3242
+ ```typescript
3243
+ public readonly artifactsDirectory: string;
3244
+ ```
3245
+
3246
+ - *Type:* string
3247
+
3248
+ The build output directory.
3249
+
3250
+ An npm tarball will be created under the `js`
3251
+ subdirectory. For example, if this is set to `dist` (the default), the npm
3252
+ tarball will be placed under `dist/js/boom-boom-1.2.3.tg`.
3253
+
3254
+ ---
3255
+
3256
+ ##### `artifactsJavascriptDirectory`<sup>Required</sup> <a name="artifactsJavascriptDirectory" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.artifactsJavascriptDirectory"></a>
3257
+
3258
+ ```typescript
3259
+ public readonly artifactsJavascriptDirectory: string;
3260
+ ```
3261
+
3262
+ - *Type:* string
3263
+
3264
+ The location of the npm tarball after build (`${artifactsDirectory}/js`).
3265
+
3266
+ ---
3267
+
3268
+ ##### `bundler`<sup>Required</sup> <a name="bundler" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.bundler"></a>
3269
+
3270
+ ```typescript
3271
+ public readonly bundler: Bundler;
3272
+ ```
3273
+
3274
+ - *Type:* projen.javascript.Bundler
3275
+
3276
+ ---
3277
+
3278
+ ##### ~~`entrypoint`~~<sup>Required</sup> <a name="entrypoint" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.entrypoint"></a>
3279
+
3280
+ - *Deprecated:* use `package.entrypoint`
3281
+
3282
+ ```typescript
3283
+ public readonly entrypoint: string;
3284
+ ```
3285
+
3286
+ - *Type:* string
3287
+
3288
+ ---
3289
+
3290
+ ##### ~~`manifest`~~<sup>Required</sup> <a name="manifest" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.manifest"></a>
3291
+
3292
+ - *Deprecated:* use `package.addField(x, y)`
3293
+
3294
+ ```typescript
3295
+ public readonly manifest: any;
3296
+ ```
3297
+
3298
+ - *Type:* any
3299
+
3300
+ ---
3301
+
3302
+ ##### `package`<sup>Required</sup> <a name="package" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.package"></a>
3303
+
3304
+ ```typescript
3305
+ public readonly package: NodePackage;
3306
+ ```
3307
+
3308
+ - *Type:* projen.javascript.NodePackage
3309
+
3310
+ API for managing the node package.
3311
+
3312
+ ---
3313
+
3314
+ ##### ~~`packageManager`~~<sup>Required</sup> <a name="packageManager" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.packageManager"></a>
3315
+
3316
+ - *Deprecated:* use `package.packageManager`
3317
+
3318
+ ```typescript
3319
+ public readonly packageManager: NodePackageManager;
3320
+ ```
3321
+
3322
+ - *Type:* projen.javascript.NodePackageManager
3323
+
3324
+ The package manager to use.
3325
+
3326
+ ---
3327
+
3328
+ ##### `runScriptCommand`<sup>Required</sup> <a name="runScriptCommand" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.runScriptCommand"></a>
3329
+
3330
+ ```typescript
3331
+ public readonly runScriptCommand: string;
3332
+ ```
3333
+
3334
+ - *Type:* string
3335
+
3336
+ The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager).
3337
+
3338
+ ---
3339
+
3340
+ ##### `autoMerge`<sup>Optional</sup> <a name="autoMerge" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.autoMerge"></a>
3341
+
3342
+ ```typescript
3343
+ public readonly autoMerge: AutoMerge;
3344
+ ```
3345
+
3346
+ - *Type:* projen.github.AutoMerge
3347
+
3348
+ Component that sets up mergify for merging approved pull requests.
3349
+
3350
+ ---
3351
+
3352
+ ##### `buildWorkflow`<sup>Optional</sup> <a name="buildWorkflow" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.buildWorkflow"></a>
3353
+
3354
+ ```typescript
3355
+ public readonly buildWorkflow: BuildWorkflow;
3356
+ ```
3357
+
3358
+ - *Type:* projen.build.BuildWorkflow
3359
+
3360
+ The PR build GitHub workflow.
3361
+
3362
+ `undefined` if `buildWorkflow` is disabled.
3363
+
3364
+ ---
3365
+
3366
+ ##### `buildWorkflowJobId`<sup>Optional</sup> <a name="buildWorkflowJobId" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.buildWorkflowJobId"></a>
3367
+
3368
+ ```typescript
3369
+ public readonly buildWorkflowJobId: string;
3370
+ ```
3371
+
3372
+ - *Type:* string
3373
+
3374
+ The job ID of the build workflow.
3375
+
3376
+ ---
3377
+
3378
+ ##### `jest`<sup>Optional</sup> <a name="jest" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.jest"></a>
3379
+
3380
+ ```typescript
3381
+ public readonly jest: Jest;
3382
+ ```
3383
+
3384
+ - *Type:* projen.javascript.Jest
3385
+
3386
+ The Jest configuration (if enabled).
3387
+
3388
+ ---
3389
+
3390
+ ##### `maxNodeVersion`<sup>Optional</sup> <a name="maxNodeVersion" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.maxNodeVersion"></a>
3391
+
3392
+ ```typescript
3393
+ public readonly maxNodeVersion: string;
3394
+ ```
3395
+
3396
+ - *Type:* string
3397
+
3398
+ Maximum node version required by this pacakge.
3399
+
3400
+ ---
3401
+
3402
+ ##### `minNodeVersion`<sup>Optional</sup> <a name="minNodeVersion" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.minNodeVersion"></a>
3403
+
3404
+ ```typescript
3405
+ public readonly minNodeVersion: string;
3406
+ ```
3407
+
3408
+ - *Type:* string
3409
+
3410
+ Minimum node.js version required by this package.
3411
+
3412
+ ---
3413
+
3414
+ ##### `npmignore`<sup>Optional</sup> <a name="npmignore" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.npmignore"></a>
3415
+
3416
+ ```typescript
3417
+ public readonly npmignore: IgnoreFile;
3418
+ ```
3419
+
3420
+ - *Type:* projen.IgnoreFile
3421
+
3422
+ The .npmignore file.
3423
+
3424
+ ---
3425
+
3426
+ ##### `prettier`<sup>Optional</sup> <a name="prettier" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.prettier"></a>
3427
+
3428
+ ```typescript
3429
+ public readonly prettier: Prettier;
3430
+ ```
3431
+
3432
+ - *Type:* projen.javascript.Prettier
3433
+
3434
+ ---
3435
+
3436
+ ##### ~~`publisher`~~<sup>Optional</sup> <a name="publisher" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.publisher"></a>
3437
+
3438
+ - *Deprecated:* use `release.publisher`.
3439
+
3440
+ ```typescript
3441
+ public readonly publisher: Publisher;
3442
+ ```
3443
+
3444
+ - *Type:* projen.release.Publisher
3445
+
3446
+ Package publisher.
3447
+
3448
+ This will be `undefined` if the project does not have a
3449
+ release workflow.
3450
+
3451
+ ---
3452
+
3453
+ ##### `release`<sup>Optional</sup> <a name="release" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.release"></a>
3454
+
3455
+ ```typescript
3456
+ public readonly release: Release;
3457
+ ```
3458
+
3459
+ - *Type:* projen.release.Release
3460
+
3461
+ Release management.
3462
+
3463
+ ---
3464
+
3465
+ ##### `upgradeWorkflow`<sup>Optional</sup> <a name="upgradeWorkflow" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.upgradeWorkflow"></a>
3466
+
3467
+ ```typescript
3468
+ public readonly upgradeWorkflow: UpgradeDependencies;
3469
+ ```
3470
+
3471
+ - *Type:* projen.javascript.UpgradeDependencies
3472
+
3473
+ The upgrade workflow.
3474
+
3475
+ ---
3476
+
3477
+ ##### `docsDirectory`<sup>Required</sup> <a name="docsDirectory" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.docsDirectory"></a>
3478
+
3479
+ ```typescript
3480
+ public readonly docsDirectory: string;
3481
+ ```
3482
+
3483
+ - *Type:* string
3484
+
3485
+ ---
3486
+
3487
+ ##### `libdir`<sup>Required</sup> <a name="libdir" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.libdir"></a>
3488
+
3489
+ ```typescript
3490
+ public readonly libdir: string;
3491
+ ```
3492
+
3493
+ - *Type:* string
3494
+
3495
+ The directory in which compiled .js files reside.
3496
+
3497
+ ---
3498
+
3499
+ ##### `srcdir`<sup>Required</sup> <a name="srcdir" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.srcdir"></a>
3500
+
3501
+ ```typescript
3502
+ public readonly srcdir: string;
3503
+ ```
3504
+
3505
+ - *Type:* string
3506
+
3507
+ The directory in which the .ts sources reside.
3508
+
3509
+ ---
3510
+
3511
+ ##### `testdir`<sup>Required</sup> <a name="testdir" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.testdir"></a>
3512
+
3513
+ ```typescript
3514
+ public readonly testdir: string;
3515
+ ```
3516
+
3517
+ - *Type:* string
3518
+
3519
+ The directory in which tests reside.
3520
+
3521
+ ---
3522
+
3523
+ ##### `tsconfigDev`<sup>Required</sup> <a name="tsconfigDev" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.tsconfigDev"></a>
3524
+
3525
+ ```typescript
3526
+ public readonly tsconfigDev: TypescriptConfig;
3527
+ ```
3528
+
3529
+ - *Type:* projen.javascript.TypescriptConfig
3530
+
3531
+ A typescript configuration file which covers all files (sources, tests, projen).
3532
+
3533
+ ---
3534
+
3535
+ ##### `watchTask`<sup>Required</sup> <a name="watchTask" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.watchTask"></a>
3536
+
3537
+ ```typescript
3538
+ public readonly watchTask: Task;
3539
+ ```
3540
+
3541
+ - *Type:* projen.Task
3542
+
3543
+ The "watch" task.
3544
+
3545
+ ---
3546
+
3547
+ ##### `docgen`<sup>Optional</sup> <a name="docgen" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.docgen"></a>
3548
+
3549
+ ```typescript
3550
+ public readonly docgen: boolean;
3551
+ ```
3552
+
3553
+ - *Type:* boolean
3554
+
3555
+ ---
3556
+
3557
+ ##### `eslint`<sup>Optional</sup> <a name="eslint" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.eslint"></a>
3558
+
3559
+ ```typescript
3560
+ public readonly eslint: Eslint;
3561
+ ```
3562
+
3563
+ - *Type:* projen.javascript.Eslint
3564
+
3565
+ ---
3566
+
3567
+ ##### `tsconfig`<sup>Optional</sup> <a name="tsconfig" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.tsconfig"></a>
3568
+
3569
+ ```typescript
3570
+ public readonly tsconfig: TypescriptConfig;
3571
+ ```
3572
+
3573
+ - *Type:* projen.javascript.TypescriptConfig
3574
+
3575
+ ---
3576
+
3577
+ ##### `tsconfigEslint`<sup>Optional</sup> <a name="tsconfigEslint" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.tsconfigEslint"></a>
3578
+
3579
+ ```typescript
3580
+ public readonly tsconfigEslint: TypescriptConfig;
3581
+ ```
3582
+
3583
+ - *Type:* projen.javascript.TypescriptConfig
3584
+
3585
+ ---
3586
+
3587
+ #### Constants <a name="Constants" id="Constants"></a>
3588
+
3589
+ | **Name** | **Type** | **Description** |
3590
+ | --- | --- | --- |
3591
+ | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProject.property.DEFAULT_TASK">DEFAULT_TASK</a></code> | <code>string</code> | The name of the default task (the task executed when `projen` is run without arguments). |
3592
+
3593
+ ---
3594
+
3595
+ ##### `DEFAULT_TASK`<sup>Required</sup> <a name="DEFAULT_TASK" id="@skeptools/skep-organization-project.SkepOrganizationProject.property.DEFAULT_TASK"></a>
3596
+
3597
+ ```typescript
3598
+ public readonly DEFAULT_TASK: string;
3599
+ ```
3600
+
3601
+ - *Type:* string
3602
+
3603
+ The name of the default task (the task executed when `projen` is run without arguments).
3604
+
3605
+ Normally
3606
+ this task should synthesize the project files.
3607
+
3608
+ ---
3609
+
3610
+