lerna-projen 0.0.337 → 0.0.339
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +137 -14
- package/API.md +1991 -2
- package/lib/index.d.ts +32 -10
- package/lib/index.js +76 -37
- package/lib/types.d.ts +3 -1
- package/lib/types.js +1 -1
- package/package.json +3 -3
package/API.md
CHANGED
|
@@ -1748,6 +1748,1927 @@ Whether or not to use workspaces in the package.json file Otherwise, will add pa
|
|
|
1748
1748
|
|
|
1749
1749
|
---
|
|
1750
1750
|
|
|
1751
|
+
### LernaTypescriptProjectOptions <a name="lerna-projen.LernaTypescriptProjectOptions"></a>
|
|
1752
|
+
|
|
1753
|
+
#### Initializer <a name="[object Object].Initializer"></a>
|
|
1754
|
+
|
|
1755
|
+
```typescript
|
|
1756
|
+
import { LernaTypescriptProjectOptions } from 'lerna-projen'
|
|
1757
|
+
|
|
1758
|
+
const lernaTypescriptProjectOptions: LernaTypescriptProjectOptions = { ... }
|
|
1759
|
+
```
|
|
1760
|
+
|
|
1761
|
+
##### `name`<sup>Required</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.name"></a>
|
|
1762
|
+
|
|
1763
|
+
```typescript
|
|
1764
|
+
public readonly name: string;
|
|
1765
|
+
```
|
|
1766
|
+
|
|
1767
|
+
- *Type:* `string`
|
|
1768
|
+
- *Default:* $BASEDIR
|
|
1769
|
+
|
|
1770
|
+
This is the name of your project.
|
|
1771
|
+
|
|
1772
|
+
---
|
|
1773
|
+
|
|
1774
|
+
##### `commitGenerated`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.commitGenerated"></a>
|
|
1775
|
+
|
|
1776
|
+
```typescript
|
|
1777
|
+
public readonly commitGenerated: boolean;
|
|
1778
|
+
```
|
|
1779
|
+
|
|
1780
|
+
- *Type:* `boolean`
|
|
1781
|
+
- *Default:* true
|
|
1782
|
+
|
|
1783
|
+
Whether to commit the managed files by default.
|
|
1784
|
+
|
|
1785
|
+
---
|
|
1786
|
+
|
|
1787
|
+
##### `logging`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.logging"></a>
|
|
1788
|
+
|
|
1789
|
+
```typescript
|
|
1790
|
+
public readonly logging: LoggerOptions;
|
|
1791
|
+
```
|
|
1792
|
+
|
|
1793
|
+
- *Type:* [`projen.LoggerOptions`](#projen.LoggerOptions)
|
|
1794
|
+
- *Default:* {}
|
|
1795
|
+
|
|
1796
|
+
Configure logging options such as verbosity.
|
|
1797
|
+
|
|
1798
|
+
---
|
|
1799
|
+
|
|
1800
|
+
##### `outdir`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.outdir"></a>
|
|
1801
|
+
|
|
1802
|
+
```typescript
|
|
1803
|
+
public readonly outdir: string;
|
|
1804
|
+
```
|
|
1805
|
+
|
|
1806
|
+
- *Type:* `string`
|
|
1807
|
+
- *Default:* "."
|
|
1808
|
+
|
|
1809
|
+
The root directory of the project.
|
|
1810
|
+
|
|
1811
|
+
Relative to this directory, all files are synthesized.
|
|
1812
|
+
|
|
1813
|
+
If this project has a parent, this directory is relative to the parent
|
|
1814
|
+
directory and it cannot be the same as the parent or any of it's other
|
|
1815
|
+
sub-projects.
|
|
1816
|
+
|
|
1817
|
+
---
|
|
1818
|
+
|
|
1819
|
+
##### `parent`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.parent"></a>
|
|
1820
|
+
|
|
1821
|
+
```typescript
|
|
1822
|
+
public readonly parent: Project;
|
|
1823
|
+
```
|
|
1824
|
+
|
|
1825
|
+
- *Type:* [`projen.Project`](#projen.Project)
|
|
1826
|
+
|
|
1827
|
+
The parent project, if this project is part of a bigger project.
|
|
1828
|
+
|
|
1829
|
+
---
|
|
1830
|
+
|
|
1831
|
+
##### `projenCommand`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.projenCommand"></a>
|
|
1832
|
+
|
|
1833
|
+
```typescript
|
|
1834
|
+
public readonly projenCommand: string;
|
|
1835
|
+
```
|
|
1836
|
+
|
|
1837
|
+
- *Type:* `string`
|
|
1838
|
+
- *Default:* "npx projen"
|
|
1839
|
+
|
|
1840
|
+
The shell command to use in order to run the projen CLI.
|
|
1841
|
+
|
|
1842
|
+
Can be used to customize in special environments.
|
|
1843
|
+
|
|
1844
|
+
---
|
|
1845
|
+
|
|
1846
|
+
##### `projenrcJson`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.projenrcJson"></a>
|
|
1847
|
+
|
|
1848
|
+
```typescript
|
|
1849
|
+
public readonly projenrcJson: boolean;
|
|
1850
|
+
```
|
|
1851
|
+
|
|
1852
|
+
- *Type:* `boolean`
|
|
1853
|
+
- *Default:* false
|
|
1854
|
+
|
|
1855
|
+
Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
|
|
1856
|
+
|
|
1857
|
+
---
|
|
1858
|
+
|
|
1859
|
+
##### `projenrcJsonOptions`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.projenrcJsonOptions"></a>
|
|
1860
|
+
|
|
1861
|
+
```typescript
|
|
1862
|
+
public readonly projenrcJsonOptions: ProjenrcOptions;
|
|
1863
|
+
```
|
|
1864
|
+
|
|
1865
|
+
- *Type:* [`projen.ProjenrcOptions`](#projen.ProjenrcOptions)
|
|
1866
|
+
- *Default:* default options
|
|
1867
|
+
|
|
1868
|
+
Options for .projenrc.json.
|
|
1869
|
+
|
|
1870
|
+
---
|
|
1871
|
+
|
|
1872
|
+
##### `renovatebot`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.renovatebot"></a>
|
|
1873
|
+
|
|
1874
|
+
```typescript
|
|
1875
|
+
public readonly renovatebot: boolean;
|
|
1876
|
+
```
|
|
1877
|
+
|
|
1878
|
+
- *Type:* `boolean`
|
|
1879
|
+
- *Default:* false
|
|
1880
|
+
|
|
1881
|
+
Use renovatebot to handle dependency upgrades.
|
|
1882
|
+
|
|
1883
|
+
---
|
|
1884
|
+
|
|
1885
|
+
##### `renovatebotOptions`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.renovatebotOptions"></a>
|
|
1886
|
+
|
|
1887
|
+
```typescript
|
|
1888
|
+
public readonly renovatebotOptions: RenovatebotOptions;
|
|
1889
|
+
```
|
|
1890
|
+
|
|
1891
|
+
- *Type:* [`projen.RenovatebotOptions`](#projen.RenovatebotOptions)
|
|
1892
|
+
- *Default:* default options
|
|
1893
|
+
|
|
1894
|
+
Options for renovatebot.
|
|
1895
|
+
|
|
1896
|
+
---
|
|
1897
|
+
|
|
1898
|
+
##### `autoApproveOptions`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.autoApproveOptions"></a>
|
|
1899
|
+
|
|
1900
|
+
```typescript
|
|
1901
|
+
public readonly autoApproveOptions: AutoApproveOptions;
|
|
1902
|
+
```
|
|
1903
|
+
|
|
1904
|
+
- *Type:* [`projen.github.AutoApproveOptions`](#projen.github.AutoApproveOptions)
|
|
1905
|
+
- *Default:* auto approve is disabled
|
|
1906
|
+
|
|
1907
|
+
Enable and configure the 'auto approve' workflow.
|
|
1908
|
+
|
|
1909
|
+
---
|
|
1910
|
+
|
|
1911
|
+
##### `autoMerge`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.autoMerge"></a>
|
|
1912
|
+
|
|
1913
|
+
```typescript
|
|
1914
|
+
public readonly autoMerge: boolean;
|
|
1915
|
+
```
|
|
1916
|
+
|
|
1917
|
+
- *Type:* `boolean`
|
|
1918
|
+
- *Default:* true
|
|
1919
|
+
|
|
1920
|
+
Enable automatic merging on GitHub.
|
|
1921
|
+
|
|
1922
|
+
Has no effect if `github.mergify`
|
|
1923
|
+
is set to false.
|
|
1924
|
+
|
|
1925
|
+
---
|
|
1926
|
+
|
|
1927
|
+
##### `autoMergeOptions`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.autoMergeOptions"></a>
|
|
1928
|
+
|
|
1929
|
+
```typescript
|
|
1930
|
+
public readonly autoMergeOptions: AutoMergeOptions;
|
|
1931
|
+
```
|
|
1932
|
+
|
|
1933
|
+
- *Type:* [`projen.github.AutoMergeOptions`](#projen.github.AutoMergeOptions)
|
|
1934
|
+
- *Default:* see defaults in `AutoMergeOptions`
|
|
1935
|
+
|
|
1936
|
+
Configure options for automatic merging on GitHub.
|
|
1937
|
+
|
|
1938
|
+
Has no effect if
|
|
1939
|
+
`github.mergify` or `autoMerge` is set to false.
|
|
1940
|
+
|
|
1941
|
+
---
|
|
1942
|
+
|
|
1943
|
+
##### `clobber`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.clobber"></a>
|
|
1944
|
+
|
|
1945
|
+
```typescript
|
|
1946
|
+
public readonly clobber: boolean;
|
|
1947
|
+
```
|
|
1948
|
+
|
|
1949
|
+
- *Type:* `boolean`
|
|
1950
|
+
- *Default:* true
|
|
1951
|
+
|
|
1952
|
+
Add a `clobber` task which resets the repo to origin.
|
|
1953
|
+
|
|
1954
|
+
---
|
|
1955
|
+
|
|
1956
|
+
##### `devContainer`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.devContainer"></a>
|
|
1957
|
+
|
|
1958
|
+
```typescript
|
|
1959
|
+
public readonly devContainer: boolean;
|
|
1960
|
+
```
|
|
1961
|
+
|
|
1962
|
+
- *Type:* `boolean`
|
|
1963
|
+
- *Default:* false
|
|
1964
|
+
|
|
1965
|
+
Add a VSCode development environment (used for GitHub Codespaces).
|
|
1966
|
+
|
|
1967
|
+
---
|
|
1968
|
+
|
|
1969
|
+
##### `github`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.github"></a>
|
|
1970
|
+
|
|
1971
|
+
```typescript
|
|
1972
|
+
public readonly github: boolean;
|
|
1973
|
+
```
|
|
1974
|
+
|
|
1975
|
+
- *Type:* `boolean`
|
|
1976
|
+
- *Default:* true
|
|
1977
|
+
|
|
1978
|
+
Enable GitHub integration.
|
|
1979
|
+
|
|
1980
|
+
Enabled by default for root projects. Disabled for non-root projects.
|
|
1981
|
+
|
|
1982
|
+
---
|
|
1983
|
+
|
|
1984
|
+
##### `githubOptions`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.githubOptions"></a>
|
|
1985
|
+
|
|
1986
|
+
```typescript
|
|
1987
|
+
public readonly githubOptions: GitHubOptions;
|
|
1988
|
+
```
|
|
1989
|
+
|
|
1990
|
+
- *Type:* [`projen.github.GitHubOptions`](#projen.github.GitHubOptions)
|
|
1991
|
+
- *Default:* see GitHubOptions
|
|
1992
|
+
|
|
1993
|
+
Options for GitHub integration.
|
|
1994
|
+
|
|
1995
|
+
---
|
|
1996
|
+
|
|
1997
|
+
##### `gitpod`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.gitpod"></a>
|
|
1998
|
+
|
|
1999
|
+
```typescript
|
|
2000
|
+
public readonly gitpod: boolean;
|
|
2001
|
+
```
|
|
2002
|
+
|
|
2003
|
+
- *Type:* `boolean`
|
|
2004
|
+
- *Default:* false
|
|
2005
|
+
|
|
2006
|
+
Add a Gitpod development environment.
|
|
2007
|
+
|
|
2008
|
+
---
|
|
2009
|
+
|
|
2010
|
+
##### ~~`mergify`~~<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.mergify"></a>
|
|
2011
|
+
|
|
2012
|
+
- *Deprecated:* use `githubOptions.mergify` instead
|
|
2013
|
+
|
|
2014
|
+
```typescript
|
|
2015
|
+
public readonly mergify: boolean;
|
|
2016
|
+
```
|
|
2017
|
+
|
|
2018
|
+
- *Type:* `boolean`
|
|
2019
|
+
- *Default:* true
|
|
2020
|
+
|
|
2021
|
+
Whether mergify should be enabled on this repository or not.
|
|
2022
|
+
|
|
2023
|
+
---
|
|
2024
|
+
|
|
2025
|
+
##### ~~`mergifyOptions`~~<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.mergifyOptions"></a>
|
|
2026
|
+
|
|
2027
|
+
- *Deprecated:* use `githubOptions.mergifyOptions` instead
|
|
2028
|
+
|
|
2029
|
+
```typescript
|
|
2030
|
+
public readonly mergifyOptions: MergifyOptions;
|
|
2031
|
+
```
|
|
2032
|
+
|
|
2033
|
+
- *Type:* [`projen.github.MergifyOptions`](#projen.github.MergifyOptions)
|
|
2034
|
+
- *Default:* default options
|
|
2035
|
+
|
|
2036
|
+
Options for mergify.
|
|
2037
|
+
|
|
2038
|
+
---
|
|
2039
|
+
|
|
2040
|
+
##### ~~`projectType`~~<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.projectType"></a>
|
|
2041
|
+
|
|
2042
|
+
- *Deprecated:* no longer supported at the base project level
|
|
2043
|
+
|
|
2044
|
+
```typescript
|
|
2045
|
+
public readonly projectType: ProjectType;
|
|
2046
|
+
```
|
|
2047
|
+
|
|
2048
|
+
- *Type:* [`projen.ProjectType`](#projen.ProjectType)
|
|
2049
|
+
- *Default:* ProjectType.UNKNOWN
|
|
2050
|
+
|
|
2051
|
+
Which type of project this is (library/app).
|
|
2052
|
+
|
|
2053
|
+
---
|
|
2054
|
+
|
|
2055
|
+
##### `projenCredentials`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.projenCredentials"></a>
|
|
2056
|
+
|
|
2057
|
+
```typescript
|
|
2058
|
+
public readonly projenCredentials: GithubCredentials;
|
|
2059
|
+
```
|
|
2060
|
+
|
|
2061
|
+
- *Type:* [`projen.github.GithubCredentials`](#projen.github.GithubCredentials)
|
|
2062
|
+
- *Default:* use a personal access token named PROJEN_GITHUB_TOKEN
|
|
2063
|
+
|
|
2064
|
+
Choose a method of providing GitHub API access for projen workflows.
|
|
2065
|
+
|
|
2066
|
+
---
|
|
2067
|
+
|
|
2068
|
+
##### ~~`projenTokenSecret`~~<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.projenTokenSecret"></a>
|
|
2069
|
+
|
|
2070
|
+
- *Deprecated:* use `projenCredentials`
|
|
2071
|
+
|
|
2072
|
+
```typescript
|
|
2073
|
+
public readonly projenTokenSecret: string;
|
|
2074
|
+
```
|
|
2075
|
+
|
|
2076
|
+
- *Type:* `string`
|
|
2077
|
+
- *Default:* "PROJEN_GITHUB_TOKEN"
|
|
2078
|
+
|
|
2079
|
+
The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
|
|
2080
|
+
|
|
2081
|
+
This token needs to have the `repo`, `workflows`
|
|
2082
|
+
and `packages` scope.
|
|
2083
|
+
|
|
2084
|
+
---
|
|
2085
|
+
|
|
2086
|
+
##### `readme`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.readme"></a>
|
|
2087
|
+
|
|
2088
|
+
```typescript
|
|
2089
|
+
public readonly readme: SampleReadmeProps;
|
|
2090
|
+
```
|
|
2091
|
+
|
|
2092
|
+
- *Type:* [`projen.SampleReadmeProps`](#projen.SampleReadmeProps)
|
|
2093
|
+
- *Default:* { filename: 'README.md', contents: '# replace this' }
|
|
2094
|
+
|
|
2095
|
+
The README setup.
|
|
2096
|
+
|
|
2097
|
+
---
|
|
2098
|
+
|
|
2099
|
+
##### `stale`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.stale"></a>
|
|
2100
|
+
|
|
2101
|
+
```typescript
|
|
2102
|
+
public readonly stale: boolean;
|
|
2103
|
+
```
|
|
2104
|
+
|
|
2105
|
+
- *Type:* `boolean`
|
|
2106
|
+
- *Default:* false
|
|
2107
|
+
|
|
2108
|
+
Auto-close of stale issues and pull request.
|
|
2109
|
+
|
|
2110
|
+
See `staleOptions` for options.
|
|
2111
|
+
|
|
2112
|
+
---
|
|
2113
|
+
|
|
2114
|
+
##### `staleOptions`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.staleOptions"></a>
|
|
2115
|
+
|
|
2116
|
+
```typescript
|
|
2117
|
+
public readonly staleOptions: StaleOptions;
|
|
2118
|
+
```
|
|
2119
|
+
|
|
2120
|
+
- *Type:* [`projen.github.StaleOptions`](#projen.github.StaleOptions)
|
|
2121
|
+
- *Default:* see defaults in `StaleOptions`
|
|
2122
|
+
|
|
2123
|
+
Auto-close stale issues and pull requests.
|
|
2124
|
+
|
|
2125
|
+
To disable set `stale` to `false`.
|
|
2126
|
+
|
|
2127
|
+
---
|
|
2128
|
+
|
|
2129
|
+
##### `vscode`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.vscode"></a>
|
|
2130
|
+
|
|
2131
|
+
```typescript
|
|
2132
|
+
public readonly vscode: boolean;
|
|
2133
|
+
```
|
|
2134
|
+
|
|
2135
|
+
- *Type:* `boolean`
|
|
2136
|
+
- *Default:* true
|
|
2137
|
+
|
|
2138
|
+
Enable VSCode integration.
|
|
2139
|
+
|
|
2140
|
+
Enabled by default for root projects. Disabled for non-root projects.
|
|
2141
|
+
|
|
2142
|
+
---
|
|
2143
|
+
|
|
2144
|
+
##### `allowLibraryDependencies`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.allowLibraryDependencies"></a>
|
|
2145
|
+
|
|
2146
|
+
```typescript
|
|
2147
|
+
public readonly allowLibraryDependencies: boolean;
|
|
2148
|
+
```
|
|
2149
|
+
|
|
2150
|
+
- *Type:* `boolean`
|
|
2151
|
+
- *Default:* true
|
|
2152
|
+
|
|
2153
|
+
Allow the project to include `peerDependencies` and `bundledDependencies`.
|
|
2154
|
+
|
|
2155
|
+
This is normally only allowed for libraries. For apps, there's no meaning
|
|
2156
|
+
for specifying these.
|
|
2157
|
+
|
|
2158
|
+
---
|
|
2159
|
+
|
|
2160
|
+
##### `authorEmail`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.authorEmail"></a>
|
|
2161
|
+
|
|
2162
|
+
```typescript
|
|
2163
|
+
public readonly authorEmail: string;
|
|
2164
|
+
```
|
|
2165
|
+
|
|
2166
|
+
- *Type:* `string`
|
|
2167
|
+
|
|
2168
|
+
Author's e-mail.
|
|
2169
|
+
|
|
2170
|
+
---
|
|
2171
|
+
|
|
2172
|
+
##### `authorName`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.authorName"></a>
|
|
2173
|
+
|
|
2174
|
+
```typescript
|
|
2175
|
+
public readonly authorName: string;
|
|
2176
|
+
```
|
|
2177
|
+
|
|
2178
|
+
- *Type:* `string`
|
|
2179
|
+
|
|
2180
|
+
Author's name.
|
|
2181
|
+
|
|
2182
|
+
---
|
|
2183
|
+
|
|
2184
|
+
##### `authorOrganization`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.authorOrganization"></a>
|
|
2185
|
+
|
|
2186
|
+
```typescript
|
|
2187
|
+
public readonly authorOrganization: boolean;
|
|
2188
|
+
```
|
|
2189
|
+
|
|
2190
|
+
- *Type:* `boolean`
|
|
2191
|
+
|
|
2192
|
+
Is the author an organization.
|
|
2193
|
+
|
|
2194
|
+
---
|
|
2195
|
+
|
|
2196
|
+
##### `authorUrl`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.authorUrl"></a>
|
|
2197
|
+
|
|
2198
|
+
```typescript
|
|
2199
|
+
public readonly authorUrl: string;
|
|
2200
|
+
```
|
|
2201
|
+
|
|
2202
|
+
- *Type:* `string`
|
|
2203
|
+
|
|
2204
|
+
Author's URL / Website.
|
|
2205
|
+
|
|
2206
|
+
---
|
|
2207
|
+
|
|
2208
|
+
##### `autoDetectBin`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.autoDetectBin"></a>
|
|
2209
|
+
|
|
2210
|
+
```typescript
|
|
2211
|
+
public readonly autoDetectBin: boolean;
|
|
2212
|
+
```
|
|
2213
|
+
|
|
2214
|
+
- *Type:* `boolean`
|
|
2215
|
+
- *Default:* true
|
|
2216
|
+
|
|
2217
|
+
Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
|
|
2218
|
+
|
|
2219
|
+
---
|
|
2220
|
+
|
|
2221
|
+
##### `bin`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.bin"></a>
|
|
2222
|
+
|
|
2223
|
+
```typescript
|
|
2224
|
+
public readonly bin: {[ key: string ]: string};
|
|
2225
|
+
```
|
|
2226
|
+
|
|
2227
|
+
- *Type:* {[ key: string ]: `string`}
|
|
2228
|
+
|
|
2229
|
+
Binary programs vended with your module.
|
|
2230
|
+
|
|
2231
|
+
You can use this option to add/customize how binaries are represented in
|
|
2232
|
+
your `package.json`, but unless `autoDetectBin` is `false`, every
|
|
2233
|
+
executable file under `bin` will automatically be added to this section.
|
|
2234
|
+
|
|
2235
|
+
---
|
|
2236
|
+
|
|
2237
|
+
##### `bugsEmail`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.bugsEmail"></a>
|
|
2238
|
+
|
|
2239
|
+
```typescript
|
|
2240
|
+
public readonly bugsEmail: string;
|
|
2241
|
+
```
|
|
2242
|
+
|
|
2243
|
+
- *Type:* `string`
|
|
2244
|
+
|
|
2245
|
+
The email address to which issues should be reported.
|
|
2246
|
+
|
|
2247
|
+
---
|
|
2248
|
+
|
|
2249
|
+
##### `bugsUrl`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.bugsUrl"></a>
|
|
2250
|
+
|
|
2251
|
+
```typescript
|
|
2252
|
+
public readonly bugsUrl: string;
|
|
2253
|
+
```
|
|
2254
|
+
|
|
2255
|
+
- *Type:* `string`
|
|
2256
|
+
|
|
2257
|
+
The url to your project's issue tracker.
|
|
2258
|
+
|
|
2259
|
+
---
|
|
2260
|
+
|
|
2261
|
+
##### `bundledDeps`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.bundledDeps"></a>
|
|
2262
|
+
|
|
2263
|
+
```typescript
|
|
2264
|
+
public readonly bundledDeps: string[];
|
|
2265
|
+
```
|
|
2266
|
+
|
|
2267
|
+
- *Type:* `string`[]
|
|
2268
|
+
|
|
2269
|
+
List of dependencies to bundle into this module.
|
|
2270
|
+
|
|
2271
|
+
These modules will be
|
|
2272
|
+
added both to the `dependencies` section and `bundledDependencies` section of
|
|
2273
|
+
your `package.json`.
|
|
2274
|
+
|
|
2275
|
+
The recommendation is to only specify the module name here (e.g.
|
|
2276
|
+
`express`). This will behave similar to `yarn add` or `npm install` in the
|
|
2277
|
+
sense that it will add the module as a dependency to your `package.json`
|
|
2278
|
+
file with the latest version (`^`). You can specify semver requirements in
|
|
2279
|
+
the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and
|
|
2280
|
+
this will be what you `package.json` will eventually include.
|
|
2281
|
+
|
|
2282
|
+
---
|
|
2283
|
+
|
|
2284
|
+
##### `codeArtifactOptions`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.codeArtifactOptions"></a>
|
|
2285
|
+
|
|
2286
|
+
```typescript
|
|
2287
|
+
public readonly codeArtifactOptions: CodeArtifactOptions;
|
|
2288
|
+
```
|
|
2289
|
+
|
|
2290
|
+
- *Type:* [`projen.javascript.CodeArtifactOptions`](#projen.javascript.CodeArtifactOptions)
|
|
2291
|
+
- *Default:* undefined
|
|
2292
|
+
|
|
2293
|
+
Options for npm packages using AWS CodeArtifact.
|
|
2294
|
+
|
|
2295
|
+
This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact
|
|
2296
|
+
|
|
2297
|
+
---
|
|
2298
|
+
|
|
2299
|
+
##### `deps`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.deps"></a>
|
|
2300
|
+
|
|
2301
|
+
```typescript
|
|
2302
|
+
public readonly deps: string[];
|
|
2303
|
+
```
|
|
2304
|
+
|
|
2305
|
+
- *Type:* `string`[]
|
|
2306
|
+
- *Default:* []
|
|
2307
|
+
|
|
2308
|
+
Runtime dependencies of this module.
|
|
2309
|
+
|
|
2310
|
+
The recommendation is to only specify the module name here (e.g.
|
|
2311
|
+
`express`). This will behave similar to `yarn add` or `npm install` in the
|
|
2312
|
+
sense that it will add the module as a dependency to your `package.json`
|
|
2313
|
+
file with the latest version (`^`). You can specify semver requirements in
|
|
2314
|
+
the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and
|
|
2315
|
+
this will be what you `package.json` will eventually include.
|
|
2316
|
+
|
|
2317
|
+
---
|
|
2318
|
+
|
|
2319
|
+
##### `description`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.description"></a>
|
|
2320
|
+
|
|
2321
|
+
```typescript
|
|
2322
|
+
public readonly description: string;
|
|
2323
|
+
```
|
|
2324
|
+
|
|
2325
|
+
- *Type:* `string`
|
|
2326
|
+
|
|
2327
|
+
The description is just a string that helps people understand the purpose of the package.
|
|
2328
|
+
|
|
2329
|
+
It can be used when searching for packages in a package manager as well.
|
|
2330
|
+
See https://classic.yarnpkg.com/en/docs/package-json/#toc-description
|
|
2331
|
+
|
|
2332
|
+
---
|
|
2333
|
+
|
|
2334
|
+
##### `devDeps`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.devDeps"></a>
|
|
2335
|
+
|
|
2336
|
+
```typescript
|
|
2337
|
+
public readonly devDeps: string[];
|
|
2338
|
+
```
|
|
2339
|
+
|
|
2340
|
+
- *Type:* `string`[]
|
|
2341
|
+
- *Default:* []
|
|
2342
|
+
|
|
2343
|
+
Build dependencies for this module.
|
|
2344
|
+
|
|
2345
|
+
These dependencies will only be
|
|
2346
|
+
available in your build environment but will not be fetched when this
|
|
2347
|
+
module is consumed.
|
|
2348
|
+
|
|
2349
|
+
The recommendation is to only specify the module name here (e.g.
|
|
2350
|
+
`express`). This will behave similar to `yarn add` or `npm install` in the
|
|
2351
|
+
sense that it will add the module as a dependency to your `package.json`
|
|
2352
|
+
file with the latest version (`^`). You can specify semver requirements in
|
|
2353
|
+
the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and
|
|
2354
|
+
this will be what you `package.json` will eventually include.
|
|
2355
|
+
|
|
2356
|
+
---
|
|
2357
|
+
|
|
2358
|
+
##### `entrypoint`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.entrypoint"></a>
|
|
2359
|
+
|
|
2360
|
+
```typescript
|
|
2361
|
+
public readonly entrypoint: string;
|
|
2362
|
+
```
|
|
2363
|
+
|
|
2364
|
+
- *Type:* `string`
|
|
2365
|
+
- *Default:* "lib/index.js"
|
|
2366
|
+
|
|
2367
|
+
Module entrypoint (`main` in `package.json`).
|
|
2368
|
+
|
|
2369
|
+
Set to an empty string to not include `main` in your package.json
|
|
2370
|
+
|
|
2371
|
+
---
|
|
2372
|
+
|
|
2373
|
+
##### `homepage`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.homepage"></a>
|
|
2374
|
+
|
|
2375
|
+
```typescript
|
|
2376
|
+
public readonly homepage: string;
|
|
2377
|
+
```
|
|
2378
|
+
|
|
2379
|
+
- *Type:* `string`
|
|
2380
|
+
|
|
2381
|
+
Package's Homepage / Website.
|
|
2382
|
+
|
|
2383
|
+
---
|
|
2384
|
+
|
|
2385
|
+
##### `keywords`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.keywords"></a>
|
|
2386
|
+
|
|
2387
|
+
```typescript
|
|
2388
|
+
public readonly keywords: string[];
|
|
2389
|
+
```
|
|
2390
|
+
|
|
2391
|
+
- *Type:* `string`[]
|
|
2392
|
+
|
|
2393
|
+
Keywords to include in `package.json`.
|
|
2394
|
+
|
|
2395
|
+
---
|
|
2396
|
+
|
|
2397
|
+
##### `license`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.license"></a>
|
|
2398
|
+
|
|
2399
|
+
```typescript
|
|
2400
|
+
public readonly license: string;
|
|
2401
|
+
```
|
|
2402
|
+
|
|
2403
|
+
- *Type:* `string`
|
|
2404
|
+
- *Default:* "Apache-2.0"
|
|
2405
|
+
|
|
2406
|
+
License's SPDX identifier.
|
|
2407
|
+
|
|
2408
|
+
See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses.
|
|
2409
|
+
Use the `licensed` option if you want to no license to be specified.
|
|
2410
|
+
|
|
2411
|
+
---
|
|
2412
|
+
|
|
2413
|
+
##### `licensed`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.licensed"></a>
|
|
2414
|
+
|
|
2415
|
+
```typescript
|
|
2416
|
+
public readonly licensed: boolean;
|
|
2417
|
+
```
|
|
2418
|
+
|
|
2419
|
+
- *Type:* `boolean`
|
|
2420
|
+
- *Default:* true
|
|
2421
|
+
|
|
2422
|
+
Indicates if a license should be added.
|
|
2423
|
+
|
|
2424
|
+
---
|
|
2425
|
+
|
|
2426
|
+
##### `maxNodeVersion`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.maxNodeVersion"></a>
|
|
2427
|
+
|
|
2428
|
+
```typescript
|
|
2429
|
+
public readonly maxNodeVersion: string;
|
|
2430
|
+
```
|
|
2431
|
+
|
|
2432
|
+
- *Type:* `string`
|
|
2433
|
+
- *Default:* no max
|
|
2434
|
+
|
|
2435
|
+
Minimum node.js version to require via `engines` (inclusive).
|
|
2436
|
+
|
|
2437
|
+
---
|
|
2438
|
+
|
|
2439
|
+
##### `minNodeVersion`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.minNodeVersion"></a>
|
|
2440
|
+
|
|
2441
|
+
```typescript
|
|
2442
|
+
public readonly minNodeVersion: string;
|
|
2443
|
+
```
|
|
2444
|
+
|
|
2445
|
+
- *Type:* `string`
|
|
2446
|
+
- *Default:* no "engines" specified
|
|
2447
|
+
|
|
2448
|
+
Minimum Node.js version to require via package.json `engines` (inclusive).
|
|
2449
|
+
|
|
2450
|
+
---
|
|
2451
|
+
|
|
2452
|
+
##### `npmAccess`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.npmAccess"></a>
|
|
2453
|
+
|
|
2454
|
+
```typescript
|
|
2455
|
+
public readonly npmAccess: NpmAccess;
|
|
2456
|
+
```
|
|
2457
|
+
|
|
2458
|
+
- *Type:* [`projen.javascript.NpmAccess`](#projen.javascript.NpmAccess)
|
|
2459
|
+
- *Default:* for scoped packages (e.g. `foo@bar`), the default is
|
|
2460
|
+
`NpmAccess.RESTRICTED`, for non-scoped packages, the default is
|
|
2461
|
+
`NpmAccess.PUBLIC`.
|
|
2462
|
+
|
|
2463
|
+
Access level of the npm package.
|
|
2464
|
+
|
|
2465
|
+
---
|
|
2466
|
+
|
|
2467
|
+
##### ~~`npmRegistry`~~<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.npmRegistry"></a>
|
|
2468
|
+
|
|
2469
|
+
- *Deprecated:* use `npmRegistryUrl` instead
|
|
2470
|
+
|
|
2471
|
+
```typescript
|
|
2472
|
+
public readonly npmRegistry: string;
|
|
2473
|
+
```
|
|
2474
|
+
|
|
2475
|
+
- *Type:* `string`
|
|
2476
|
+
|
|
2477
|
+
The host name of the npm registry to publish to.
|
|
2478
|
+
|
|
2479
|
+
Cannot be set together with `npmRegistryUrl`.
|
|
2480
|
+
|
|
2481
|
+
---
|
|
2482
|
+
|
|
2483
|
+
##### `npmRegistryUrl`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.npmRegistryUrl"></a>
|
|
2484
|
+
|
|
2485
|
+
```typescript
|
|
2486
|
+
public readonly npmRegistryUrl: string;
|
|
2487
|
+
```
|
|
2488
|
+
|
|
2489
|
+
- *Type:* `string`
|
|
2490
|
+
- *Default:* "https://registry.npmjs.org"
|
|
2491
|
+
|
|
2492
|
+
The base URL of the npm package registry.
|
|
2493
|
+
|
|
2494
|
+
Must be a URL (e.g. start with "https://" or "http://")
|
|
2495
|
+
|
|
2496
|
+
---
|
|
2497
|
+
|
|
2498
|
+
##### `npmTokenSecret`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.npmTokenSecret"></a>
|
|
2499
|
+
|
|
2500
|
+
```typescript
|
|
2501
|
+
public readonly npmTokenSecret: string;
|
|
2502
|
+
```
|
|
2503
|
+
|
|
2504
|
+
- *Type:* `string`
|
|
2505
|
+
- *Default:* "NPM_TOKEN"
|
|
2506
|
+
|
|
2507
|
+
GitHub secret which contains the NPM token to use when publishing packages.
|
|
2508
|
+
|
|
2509
|
+
---
|
|
2510
|
+
|
|
2511
|
+
##### `packageManager`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.packageManager"></a>
|
|
2512
|
+
|
|
2513
|
+
```typescript
|
|
2514
|
+
public readonly packageManager: NodePackageManager;
|
|
2515
|
+
```
|
|
2516
|
+
|
|
2517
|
+
- *Type:* [`projen.javascript.NodePackageManager`](#projen.javascript.NodePackageManager)
|
|
2518
|
+
- *Default:* NodePackageManager.YARN
|
|
2519
|
+
|
|
2520
|
+
The Node Package Manager used to execute scripts.
|
|
2521
|
+
|
|
2522
|
+
---
|
|
2523
|
+
|
|
2524
|
+
##### `packageName`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.packageName"></a>
|
|
2525
|
+
|
|
2526
|
+
```typescript
|
|
2527
|
+
public readonly packageName: string;
|
|
2528
|
+
```
|
|
2529
|
+
|
|
2530
|
+
- *Type:* `string`
|
|
2531
|
+
- *Default:* defaults to project name
|
|
2532
|
+
|
|
2533
|
+
The "name" in package.json.
|
|
2534
|
+
|
|
2535
|
+
---
|
|
2536
|
+
|
|
2537
|
+
##### `peerDependencyOptions`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.peerDependencyOptions"></a>
|
|
2538
|
+
|
|
2539
|
+
```typescript
|
|
2540
|
+
public readonly peerDependencyOptions: PeerDependencyOptions;
|
|
2541
|
+
```
|
|
2542
|
+
|
|
2543
|
+
- *Type:* [`projen.javascript.PeerDependencyOptions`](#projen.javascript.PeerDependencyOptions)
|
|
2544
|
+
|
|
2545
|
+
Options for `peerDeps`.
|
|
2546
|
+
|
|
2547
|
+
---
|
|
2548
|
+
|
|
2549
|
+
##### `peerDeps`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.peerDeps"></a>
|
|
2550
|
+
|
|
2551
|
+
```typescript
|
|
2552
|
+
public readonly peerDeps: string[];
|
|
2553
|
+
```
|
|
2554
|
+
|
|
2555
|
+
- *Type:* `string`[]
|
|
2556
|
+
- *Default:* []
|
|
2557
|
+
|
|
2558
|
+
Peer dependencies for this module.
|
|
2559
|
+
|
|
2560
|
+
Dependencies listed here are required to
|
|
2561
|
+
be installed (and satisfied) by the _consumer_ of this library. Using peer
|
|
2562
|
+
dependencies allows you to ensure that only a single module of a certain
|
|
2563
|
+
library exists in the `node_modules` tree of your consumers.
|
|
2564
|
+
|
|
2565
|
+
Note that prior to npm@7, peer dependencies are _not_ automatically
|
|
2566
|
+
installed, which means that adding peer dependencies to a library will be a
|
|
2567
|
+
breaking change for your customers.
|
|
2568
|
+
|
|
2569
|
+
Unless `peerDependencyOptions.pinnedDevDependency` is disabled (it is
|
|
2570
|
+
enabled by default), projen will automatically add a dev dependency with a
|
|
2571
|
+
pinned version for each peer dependency. This will ensure that you build &
|
|
2572
|
+
test your module against the lowest peer version required.
|
|
2573
|
+
|
|
2574
|
+
---
|
|
2575
|
+
|
|
2576
|
+
##### `repository`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.repository"></a>
|
|
2577
|
+
|
|
2578
|
+
```typescript
|
|
2579
|
+
public readonly repository: string;
|
|
2580
|
+
```
|
|
2581
|
+
|
|
2582
|
+
- *Type:* `string`
|
|
2583
|
+
|
|
2584
|
+
The repository is the location where the actual code for your package lives.
|
|
2585
|
+
|
|
2586
|
+
See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository
|
|
2587
|
+
|
|
2588
|
+
---
|
|
2589
|
+
|
|
2590
|
+
##### `repositoryDirectory`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.repositoryDirectory"></a>
|
|
2591
|
+
|
|
2592
|
+
```typescript
|
|
2593
|
+
public readonly repositoryDirectory: string;
|
|
2594
|
+
```
|
|
2595
|
+
|
|
2596
|
+
- *Type:* `string`
|
|
2597
|
+
|
|
2598
|
+
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.
|
|
2599
|
+
|
|
2600
|
+
---
|
|
2601
|
+
|
|
2602
|
+
##### `scopedPackagesOptions`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.scopedPackagesOptions"></a>
|
|
2603
|
+
|
|
2604
|
+
```typescript
|
|
2605
|
+
public readonly scopedPackagesOptions: ScopedPackagesOptions[];
|
|
2606
|
+
```
|
|
2607
|
+
|
|
2608
|
+
- *Type:* [`projen.javascript.ScopedPackagesOptions`](#projen.javascript.ScopedPackagesOptions)[]
|
|
2609
|
+
- *Default:* fetch all scoped packages from the public npm registry
|
|
2610
|
+
|
|
2611
|
+
Options for privately hosted scoped packages.
|
|
2612
|
+
|
|
2613
|
+
---
|
|
2614
|
+
|
|
2615
|
+
##### `scripts`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.scripts"></a>
|
|
2616
|
+
|
|
2617
|
+
```typescript
|
|
2618
|
+
public readonly scripts: {[ key: string ]: string};
|
|
2619
|
+
```
|
|
2620
|
+
|
|
2621
|
+
- *Type:* {[ key: string ]: `string`}
|
|
2622
|
+
- *Default:* {}
|
|
2623
|
+
|
|
2624
|
+
npm scripts to include.
|
|
2625
|
+
|
|
2626
|
+
If a script has the same name as a standard script,
|
|
2627
|
+
the standard script will be overwritten.
|
|
2628
|
+
|
|
2629
|
+
---
|
|
2630
|
+
|
|
2631
|
+
##### `stability`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.stability"></a>
|
|
2632
|
+
|
|
2633
|
+
```typescript
|
|
2634
|
+
public readonly stability: string;
|
|
2635
|
+
```
|
|
2636
|
+
|
|
2637
|
+
- *Type:* `string`
|
|
2638
|
+
|
|
2639
|
+
Package's Stability.
|
|
2640
|
+
|
|
2641
|
+
---
|
|
2642
|
+
|
|
2643
|
+
##### `jsiiReleaseVersion`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.jsiiReleaseVersion"></a>
|
|
2644
|
+
|
|
2645
|
+
```typescript
|
|
2646
|
+
public readonly jsiiReleaseVersion: string;
|
|
2647
|
+
```
|
|
2648
|
+
|
|
2649
|
+
- *Type:* `string`
|
|
2650
|
+
- *Default:* "latest"
|
|
2651
|
+
|
|
2652
|
+
Version requirement of `publib` which is used to publish modules to npm.
|
|
2653
|
+
|
|
2654
|
+
---
|
|
2655
|
+
|
|
2656
|
+
##### `majorVersion`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.majorVersion"></a>
|
|
2657
|
+
|
|
2658
|
+
```typescript
|
|
2659
|
+
public readonly majorVersion: number;
|
|
2660
|
+
```
|
|
2661
|
+
|
|
2662
|
+
- *Type:* `number`
|
|
2663
|
+
- *Default:* Major version is not enforced.
|
|
2664
|
+
|
|
2665
|
+
Major version to release from the default branch.
|
|
2666
|
+
|
|
2667
|
+
If this is specified, we bump the latest version of this major version line.
|
|
2668
|
+
If not specified, we bump the global latest version.
|
|
2669
|
+
|
|
2670
|
+
---
|
|
2671
|
+
|
|
2672
|
+
##### `minMajorVersion`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.minMajorVersion"></a>
|
|
2673
|
+
|
|
2674
|
+
```typescript
|
|
2675
|
+
public readonly minMajorVersion: number;
|
|
2676
|
+
```
|
|
2677
|
+
|
|
2678
|
+
- *Type:* `number`
|
|
2679
|
+
- *Default:* No minimum version is being enforced
|
|
2680
|
+
|
|
2681
|
+
Minimal Major version to release.
|
|
2682
|
+
|
|
2683
|
+
This can be useful to set to 1, as breaking changes before the 1.x major
|
|
2684
|
+
release are not incrementing the major version number.
|
|
2685
|
+
|
|
2686
|
+
Can not be set together with `majorVersion`.
|
|
2687
|
+
|
|
2688
|
+
---
|
|
2689
|
+
|
|
2690
|
+
##### `npmDistTag`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.npmDistTag"></a>
|
|
2691
|
+
|
|
2692
|
+
```typescript
|
|
2693
|
+
public readonly npmDistTag: string;
|
|
2694
|
+
```
|
|
2695
|
+
|
|
2696
|
+
- *Type:* `string`
|
|
2697
|
+
- *Default:* "latest"
|
|
2698
|
+
|
|
2699
|
+
The npmDistTag to use when publishing from the default branch.
|
|
2700
|
+
|
|
2701
|
+
To set the npm dist-tag for release branches, set the `npmDistTag` property
|
|
2702
|
+
for each branch.
|
|
2703
|
+
|
|
2704
|
+
---
|
|
2705
|
+
|
|
2706
|
+
##### `postBuildSteps`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.postBuildSteps"></a>
|
|
2707
|
+
|
|
2708
|
+
```typescript
|
|
2709
|
+
public readonly postBuildSteps: JobStep[];
|
|
2710
|
+
```
|
|
2711
|
+
|
|
2712
|
+
- *Type:* [`projen.github.workflows.JobStep`](#projen.github.workflows.JobStep)[]
|
|
2713
|
+
- *Default:* []
|
|
2714
|
+
|
|
2715
|
+
Steps to execute after build as part of the release workflow.
|
|
2716
|
+
|
|
2717
|
+
---
|
|
2718
|
+
|
|
2719
|
+
##### `prerelease`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.prerelease"></a>
|
|
2720
|
+
|
|
2721
|
+
```typescript
|
|
2722
|
+
public readonly prerelease: string;
|
|
2723
|
+
```
|
|
2724
|
+
|
|
2725
|
+
- *Type:* `string`
|
|
2726
|
+
- *Default:* normal semantic versions
|
|
2727
|
+
|
|
2728
|
+
Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
|
|
2729
|
+
|
|
2730
|
+
---
|
|
2731
|
+
|
|
2732
|
+
##### `publishDryRun`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.publishDryRun"></a>
|
|
2733
|
+
|
|
2734
|
+
```typescript
|
|
2735
|
+
public readonly publishDryRun: boolean;
|
|
2736
|
+
```
|
|
2737
|
+
|
|
2738
|
+
- *Type:* `boolean`
|
|
2739
|
+
- *Default:* false
|
|
2740
|
+
|
|
2741
|
+
Instead of actually publishing to package managers, just print the publishing command.
|
|
2742
|
+
|
|
2743
|
+
---
|
|
2744
|
+
|
|
2745
|
+
##### `publishTasks`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.publishTasks"></a>
|
|
2746
|
+
|
|
2747
|
+
```typescript
|
|
2748
|
+
public readonly publishTasks: boolean;
|
|
2749
|
+
```
|
|
2750
|
+
|
|
2751
|
+
- *Type:* `boolean`
|
|
2752
|
+
- *Default:* false
|
|
2753
|
+
|
|
2754
|
+
Define publishing tasks that can be executed manually as well as workflows.
|
|
2755
|
+
|
|
2756
|
+
Normally, publishing only happens within automated workflows. Enable this
|
|
2757
|
+
in order to create a publishing task for each publishing activity.
|
|
2758
|
+
|
|
2759
|
+
---
|
|
2760
|
+
|
|
2761
|
+
##### `releaseBranches`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.releaseBranches"></a>
|
|
2762
|
+
|
|
2763
|
+
```typescript
|
|
2764
|
+
public readonly releaseBranches: {[ key: string ]: BranchOptions};
|
|
2765
|
+
```
|
|
2766
|
+
|
|
2767
|
+
- *Type:* {[ key: string ]: [`projen.release.BranchOptions`](#projen.release.BranchOptions)}
|
|
2768
|
+
- *Default:* no additional branches are used for release. you can use
|
|
2769
|
+
`addBranch()` to add additional branches.
|
|
2770
|
+
|
|
2771
|
+
Defines additional release branches.
|
|
2772
|
+
|
|
2773
|
+
A workflow will be created for each
|
|
2774
|
+
release branch which will publish releases from commits in this branch.
|
|
2775
|
+
Each release branch _must_ be assigned a major version number which is used
|
|
2776
|
+
to enforce that versions published from that branch always use that major
|
|
2777
|
+
version. If multiple branches are used, the `majorVersion` field must also
|
|
2778
|
+
be provided for the default branch.
|
|
2779
|
+
|
|
2780
|
+
---
|
|
2781
|
+
|
|
2782
|
+
##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.releaseEveryCommit"></a>
|
|
2783
|
+
|
|
2784
|
+
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
|
|
2785
|
+
|
|
2786
|
+
```typescript
|
|
2787
|
+
public readonly releaseEveryCommit: boolean;
|
|
2788
|
+
```
|
|
2789
|
+
|
|
2790
|
+
- *Type:* `boolean`
|
|
2791
|
+
- *Default:* true
|
|
2792
|
+
|
|
2793
|
+
Automatically release new versions every commit to one of branches in `releaseBranches`.
|
|
2794
|
+
|
|
2795
|
+
---
|
|
2796
|
+
|
|
2797
|
+
##### `releaseFailureIssue`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.releaseFailureIssue"></a>
|
|
2798
|
+
|
|
2799
|
+
```typescript
|
|
2800
|
+
public readonly releaseFailureIssue: boolean;
|
|
2801
|
+
```
|
|
2802
|
+
|
|
2803
|
+
- *Type:* `boolean`
|
|
2804
|
+
- *Default:* false
|
|
2805
|
+
|
|
2806
|
+
Create a github issue on every failed publishing task.
|
|
2807
|
+
|
|
2808
|
+
---
|
|
2809
|
+
|
|
2810
|
+
##### `releaseFailureIssueLabel`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.releaseFailureIssueLabel"></a>
|
|
2811
|
+
|
|
2812
|
+
```typescript
|
|
2813
|
+
public readonly releaseFailureIssueLabel: string;
|
|
2814
|
+
```
|
|
2815
|
+
|
|
2816
|
+
- *Type:* `string`
|
|
2817
|
+
- *Default:* "failed-release"
|
|
2818
|
+
|
|
2819
|
+
The label to apply to issues indicating publish failures.
|
|
2820
|
+
|
|
2821
|
+
Only applies if `releaseFailureIssue` is true.
|
|
2822
|
+
|
|
2823
|
+
---
|
|
2824
|
+
|
|
2825
|
+
##### ~~`releaseSchedule`~~<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.releaseSchedule"></a>
|
|
2826
|
+
|
|
2827
|
+
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead
|
|
2828
|
+
|
|
2829
|
+
```typescript
|
|
2830
|
+
public readonly releaseSchedule: string;
|
|
2831
|
+
```
|
|
2832
|
+
|
|
2833
|
+
- *Type:* `string`
|
|
2834
|
+
- *Default:* no scheduled releases
|
|
2835
|
+
|
|
2836
|
+
CRON schedule to trigger new releases.
|
|
2837
|
+
|
|
2838
|
+
---
|
|
2839
|
+
|
|
2840
|
+
##### `releaseTagPrefix`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.releaseTagPrefix"></a>
|
|
2841
|
+
|
|
2842
|
+
```typescript
|
|
2843
|
+
public readonly releaseTagPrefix: string;
|
|
2844
|
+
```
|
|
2845
|
+
|
|
2846
|
+
- *Type:* `string`
|
|
2847
|
+
- *Default:* "v"
|
|
2848
|
+
|
|
2849
|
+
Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
|
|
2850
|
+
|
|
2851
|
+
Note: this prefix is used to detect the latest tagged version
|
|
2852
|
+
when bumping, so if you change this on a project with an existing version
|
|
2853
|
+
history, you may need to manually tag your latest release
|
|
2854
|
+
with the new prefix.
|
|
2855
|
+
|
|
2856
|
+
---
|
|
2857
|
+
|
|
2858
|
+
##### `releaseTrigger`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.releaseTrigger"></a>
|
|
2859
|
+
|
|
2860
|
+
```typescript
|
|
2861
|
+
public readonly releaseTrigger: ReleaseTrigger;
|
|
2862
|
+
```
|
|
2863
|
+
|
|
2864
|
+
- *Type:* [`projen.release.ReleaseTrigger`](#projen.release.ReleaseTrigger)
|
|
2865
|
+
- *Default:* Continuous releases (`ReleaseTrigger.continuous()`)
|
|
2866
|
+
|
|
2867
|
+
The release trigger to use.
|
|
2868
|
+
|
|
2869
|
+
---
|
|
2870
|
+
|
|
2871
|
+
##### `releaseWorkflowName`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.releaseWorkflowName"></a>
|
|
2872
|
+
|
|
2873
|
+
```typescript
|
|
2874
|
+
public readonly releaseWorkflowName: string;
|
|
2875
|
+
```
|
|
2876
|
+
|
|
2877
|
+
- *Type:* `string`
|
|
2878
|
+
- *Default:* "Release"
|
|
2879
|
+
|
|
2880
|
+
The name of the default release workflow.
|
|
2881
|
+
|
|
2882
|
+
---
|
|
2883
|
+
|
|
2884
|
+
##### `releaseWorkflowSetupSteps`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.releaseWorkflowSetupSteps"></a>
|
|
2885
|
+
|
|
2886
|
+
```typescript
|
|
2887
|
+
public readonly releaseWorkflowSetupSteps: JobStep[];
|
|
2888
|
+
```
|
|
2889
|
+
|
|
2890
|
+
- *Type:* [`projen.github.workflows.JobStep`](#projen.github.workflows.JobStep)[]
|
|
2891
|
+
|
|
2892
|
+
A set of workflow steps to execute in order to setup the workflow container.
|
|
2893
|
+
|
|
2894
|
+
---
|
|
2895
|
+
|
|
2896
|
+
##### `versionrcOptions`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.versionrcOptions"></a>
|
|
2897
|
+
|
|
2898
|
+
```typescript
|
|
2899
|
+
public readonly versionrcOptions: {[ key: string ]: any};
|
|
2900
|
+
```
|
|
2901
|
+
|
|
2902
|
+
- *Type:* {[ key: string ]: `any`}
|
|
2903
|
+
- *Default:* standard configuration applicable for GitHub repositories
|
|
2904
|
+
|
|
2905
|
+
Custom configuration used when creating changelog with standard-version package.
|
|
2906
|
+
|
|
2907
|
+
Given values either append to default configuration or overwrite values in it.
|
|
2908
|
+
|
|
2909
|
+
---
|
|
2910
|
+
|
|
2911
|
+
##### `workflowContainerImage`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.workflowContainerImage"></a>
|
|
2912
|
+
|
|
2913
|
+
```typescript
|
|
2914
|
+
public readonly workflowContainerImage: string;
|
|
2915
|
+
```
|
|
2916
|
+
|
|
2917
|
+
- *Type:* `string`
|
|
2918
|
+
- *Default:* default image
|
|
2919
|
+
|
|
2920
|
+
Container image to use for GitHub workflows.
|
|
2921
|
+
|
|
2922
|
+
---
|
|
2923
|
+
|
|
2924
|
+
##### `workflowRunsOn`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.workflowRunsOn"></a>
|
|
2925
|
+
|
|
2926
|
+
```typescript
|
|
2927
|
+
public readonly workflowRunsOn: string[];
|
|
2928
|
+
```
|
|
2929
|
+
|
|
2930
|
+
- *Type:* `string`[]
|
|
2931
|
+
- *Default:* ["ubuntu-latest"]
|
|
2932
|
+
|
|
2933
|
+
Github Runner selection labels.
|
|
2934
|
+
|
|
2935
|
+
---
|
|
2936
|
+
|
|
2937
|
+
##### `defaultReleaseBranch`<sup>Required</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.defaultReleaseBranch"></a>
|
|
2938
|
+
|
|
2939
|
+
```typescript
|
|
2940
|
+
public readonly defaultReleaseBranch: string;
|
|
2941
|
+
```
|
|
2942
|
+
|
|
2943
|
+
- *Type:* `string`
|
|
2944
|
+
- *Default:* "main"
|
|
2945
|
+
|
|
2946
|
+
The name of the main release branch.
|
|
2947
|
+
|
|
2948
|
+
---
|
|
2949
|
+
|
|
2950
|
+
##### `artifactsDirectory`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.artifactsDirectory"></a>
|
|
2951
|
+
|
|
2952
|
+
```typescript
|
|
2953
|
+
public readonly artifactsDirectory: string;
|
|
2954
|
+
```
|
|
2955
|
+
|
|
2956
|
+
- *Type:* `string`
|
|
2957
|
+
- *Default:* "dist"
|
|
2958
|
+
|
|
2959
|
+
A directory which will contain build artifacts.
|
|
2960
|
+
|
|
2961
|
+
---
|
|
2962
|
+
|
|
2963
|
+
##### `autoApproveUpgrades`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.autoApproveUpgrades"></a>
|
|
2964
|
+
|
|
2965
|
+
```typescript
|
|
2966
|
+
public readonly autoApproveUpgrades: boolean;
|
|
2967
|
+
```
|
|
2968
|
+
|
|
2969
|
+
- *Type:* `boolean`
|
|
2970
|
+
- *Default:* true
|
|
2971
|
+
|
|
2972
|
+
Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
|
|
2973
|
+
|
|
2974
|
+
Throw if set to true but `autoApproveOptions` are not defined.
|
|
2975
|
+
|
|
2976
|
+
---
|
|
2977
|
+
|
|
2978
|
+
##### `buildWorkflow`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.buildWorkflow"></a>
|
|
2979
|
+
|
|
2980
|
+
```typescript
|
|
2981
|
+
public readonly buildWorkflow: boolean;
|
|
2982
|
+
```
|
|
2983
|
+
|
|
2984
|
+
- *Type:* `boolean`
|
|
2985
|
+
- *Default:* true if not a subproject
|
|
2986
|
+
|
|
2987
|
+
Define a GitHub workflow for building PRs.
|
|
2988
|
+
|
|
2989
|
+
---
|
|
2990
|
+
|
|
2991
|
+
##### `buildWorkflowTriggers`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.buildWorkflowTriggers"></a>
|
|
2992
|
+
|
|
2993
|
+
```typescript
|
|
2994
|
+
public readonly buildWorkflowTriggers: Triggers;
|
|
2995
|
+
```
|
|
2996
|
+
|
|
2997
|
+
- *Type:* [`projen.github.workflows.Triggers`](#projen.github.workflows.Triggers)
|
|
2998
|
+
- *Default:* "{ pullRequest: {}, workflowDispatch: {} }"
|
|
2999
|
+
|
|
3000
|
+
Build workflow triggers.
|
|
3001
|
+
|
|
3002
|
+
---
|
|
3003
|
+
|
|
3004
|
+
##### `bundlerOptions`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.bundlerOptions"></a>
|
|
3005
|
+
|
|
3006
|
+
```typescript
|
|
3007
|
+
public readonly bundlerOptions: BundlerOptions;
|
|
3008
|
+
```
|
|
3009
|
+
|
|
3010
|
+
- *Type:* [`projen.javascript.BundlerOptions`](#projen.javascript.BundlerOptions)
|
|
3011
|
+
|
|
3012
|
+
Options for `Bundler`.
|
|
3013
|
+
|
|
3014
|
+
---
|
|
3015
|
+
|
|
3016
|
+
##### `codeCov`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.codeCov"></a>
|
|
3017
|
+
|
|
3018
|
+
```typescript
|
|
3019
|
+
public readonly codeCov: boolean;
|
|
3020
|
+
```
|
|
3021
|
+
|
|
3022
|
+
- *Type:* `boolean`
|
|
3023
|
+
- *Default:* false
|
|
3024
|
+
|
|
3025
|
+
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.
|
|
3026
|
+
|
|
3027
|
+
---
|
|
3028
|
+
|
|
3029
|
+
##### `codeCovTokenSecret`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.codeCovTokenSecret"></a>
|
|
3030
|
+
|
|
3031
|
+
```typescript
|
|
3032
|
+
public readonly codeCovTokenSecret: string;
|
|
3033
|
+
```
|
|
3034
|
+
|
|
3035
|
+
- *Type:* `string`
|
|
3036
|
+
- *Default:* if this option is not specified, only public repositories are supported
|
|
3037
|
+
|
|
3038
|
+
Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
|
|
3039
|
+
|
|
3040
|
+
---
|
|
3041
|
+
|
|
3042
|
+
##### `copyrightOwner`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.copyrightOwner"></a>
|
|
3043
|
+
|
|
3044
|
+
```typescript
|
|
3045
|
+
public readonly copyrightOwner: string;
|
|
3046
|
+
```
|
|
3047
|
+
|
|
3048
|
+
- *Type:* `string`
|
|
3049
|
+
- *Default:* defaults to the value of authorName or "" if `authorName` is undefined.
|
|
3050
|
+
|
|
3051
|
+
License copyright owner.
|
|
3052
|
+
|
|
3053
|
+
---
|
|
3054
|
+
|
|
3055
|
+
##### `copyrightPeriod`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.copyrightPeriod"></a>
|
|
3056
|
+
|
|
3057
|
+
```typescript
|
|
3058
|
+
public readonly copyrightPeriod: string;
|
|
3059
|
+
```
|
|
3060
|
+
|
|
3061
|
+
- *Type:* `string`
|
|
3062
|
+
- *Default:* current year
|
|
3063
|
+
|
|
3064
|
+
The copyright years to put in the LICENSE file.
|
|
3065
|
+
|
|
3066
|
+
---
|
|
3067
|
+
|
|
3068
|
+
##### `dependabot`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.dependabot"></a>
|
|
3069
|
+
|
|
3070
|
+
```typescript
|
|
3071
|
+
public readonly dependabot: boolean;
|
|
3072
|
+
```
|
|
3073
|
+
|
|
3074
|
+
- *Type:* `boolean`
|
|
3075
|
+
- *Default:* false
|
|
3076
|
+
|
|
3077
|
+
Use dependabot to handle dependency upgrades.
|
|
3078
|
+
|
|
3079
|
+
Cannot be used in conjunction with `depsUpgrade`.
|
|
3080
|
+
|
|
3081
|
+
---
|
|
3082
|
+
|
|
3083
|
+
##### `dependabotOptions`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.dependabotOptions"></a>
|
|
3084
|
+
|
|
3085
|
+
```typescript
|
|
3086
|
+
public readonly dependabotOptions: DependabotOptions;
|
|
3087
|
+
```
|
|
3088
|
+
|
|
3089
|
+
- *Type:* [`projen.github.DependabotOptions`](#projen.github.DependabotOptions)
|
|
3090
|
+
- *Default:* default options
|
|
3091
|
+
|
|
3092
|
+
Options for dependabot.
|
|
3093
|
+
|
|
3094
|
+
---
|
|
3095
|
+
|
|
3096
|
+
##### `depsUpgrade`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.depsUpgrade"></a>
|
|
3097
|
+
|
|
3098
|
+
```typescript
|
|
3099
|
+
public readonly depsUpgrade: boolean;
|
|
3100
|
+
```
|
|
3101
|
+
|
|
3102
|
+
- *Type:* `boolean`
|
|
3103
|
+
- *Default:* true
|
|
3104
|
+
|
|
3105
|
+
Use github workflows to handle dependency upgrades.
|
|
3106
|
+
|
|
3107
|
+
Cannot be used in conjunction with `dependabot`.
|
|
3108
|
+
|
|
3109
|
+
---
|
|
3110
|
+
|
|
3111
|
+
##### `depsUpgradeOptions`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.depsUpgradeOptions"></a>
|
|
3112
|
+
|
|
3113
|
+
```typescript
|
|
3114
|
+
public readonly depsUpgradeOptions: UpgradeDependenciesOptions;
|
|
3115
|
+
```
|
|
3116
|
+
|
|
3117
|
+
- *Type:* [`projen.javascript.UpgradeDependenciesOptions`](#projen.javascript.UpgradeDependenciesOptions)
|
|
3118
|
+
- *Default:* default options
|
|
3119
|
+
|
|
3120
|
+
Options for `UpgradeDependencies`.
|
|
3121
|
+
|
|
3122
|
+
---
|
|
3123
|
+
|
|
3124
|
+
##### `gitignore`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.gitignore"></a>
|
|
3125
|
+
|
|
3126
|
+
```typescript
|
|
3127
|
+
public readonly gitignore: string[];
|
|
3128
|
+
```
|
|
3129
|
+
|
|
3130
|
+
- *Type:* `string`[]
|
|
3131
|
+
|
|
3132
|
+
Additional entries to .gitignore.
|
|
3133
|
+
|
|
3134
|
+
---
|
|
3135
|
+
|
|
3136
|
+
##### `jest`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.jest"></a>
|
|
3137
|
+
|
|
3138
|
+
```typescript
|
|
3139
|
+
public readonly jest: boolean;
|
|
3140
|
+
```
|
|
3141
|
+
|
|
3142
|
+
- *Type:* `boolean`
|
|
3143
|
+
- *Default:* true
|
|
3144
|
+
|
|
3145
|
+
Setup jest unit tests.
|
|
3146
|
+
|
|
3147
|
+
---
|
|
3148
|
+
|
|
3149
|
+
##### `jestOptions`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.jestOptions"></a>
|
|
3150
|
+
|
|
3151
|
+
```typescript
|
|
3152
|
+
public readonly jestOptions: JestOptions;
|
|
3153
|
+
```
|
|
3154
|
+
|
|
3155
|
+
- *Type:* [`projen.javascript.JestOptions`](#projen.javascript.JestOptions)
|
|
3156
|
+
- *Default:* default options
|
|
3157
|
+
|
|
3158
|
+
Jest options.
|
|
3159
|
+
|
|
3160
|
+
---
|
|
3161
|
+
|
|
3162
|
+
##### `mutableBuild`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.mutableBuild"></a>
|
|
3163
|
+
|
|
3164
|
+
```typescript
|
|
3165
|
+
public readonly mutableBuild: boolean;
|
|
3166
|
+
```
|
|
3167
|
+
|
|
3168
|
+
- *Type:* `boolean`
|
|
3169
|
+
- *Default:* true
|
|
3170
|
+
|
|
3171
|
+
Automatically update files modified during builds to pull-request branches.
|
|
3172
|
+
|
|
3173
|
+
This means
|
|
3174
|
+
that any files synthesized by projen or e.g. test snapshots will always be up-to-date
|
|
3175
|
+
before a PR is merged.
|
|
3176
|
+
|
|
3177
|
+
Implies that PR builds do not have anti-tamper checks.
|
|
3178
|
+
|
|
3179
|
+
---
|
|
3180
|
+
|
|
3181
|
+
##### ~~`npmignore`~~<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.npmignore"></a>
|
|
3182
|
+
|
|
3183
|
+
- *Deprecated:* - use `project.addPackageIgnore`
|
|
3184
|
+
|
|
3185
|
+
```typescript
|
|
3186
|
+
public readonly npmignore: string[];
|
|
3187
|
+
```
|
|
3188
|
+
|
|
3189
|
+
- *Type:* `string`[]
|
|
3190
|
+
|
|
3191
|
+
Additional entries to .npmignore.
|
|
3192
|
+
|
|
3193
|
+
---
|
|
3194
|
+
|
|
3195
|
+
##### `npmignoreEnabled`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.npmignoreEnabled"></a>
|
|
3196
|
+
|
|
3197
|
+
```typescript
|
|
3198
|
+
public readonly npmignoreEnabled: boolean;
|
|
3199
|
+
```
|
|
3200
|
+
|
|
3201
|
+
- *Type:* `boolean`
|
|
3202
|
+
- *Default:* true
|
|
3203
|
+
|
|
3204
|
+
Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
|
|
3205
|
+
|
|
3206
|
+
---
|
|
3207
|
+
|
|
3208
|
+
##### `package`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.package"></a>
|
|
3209
|
+
|
|
3210
|
+
```typescript
|
|
3211
|
+
public readonly package: boolean;
|
|
3212
|
+
```
|
|
3213
|
+
|
|
3214
|
+
- *Type:* `boolean`
|
|
3215
|
+
- *Default:* true
|
|
3216
|
+
|
|
3217
|
+
Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).
|
|
3218
|
+
|
|
3219
|
+
---
|
|
3220
|
+
|
|
3221
|
+
##### `prettier`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.prettier"></a>
|
|
3222
|
+
|
|
3223
|
+
```typescript
|
|
3224
|
+
public readonly prettier: boolean;
|
|
3225
|
+
```
|
|
3226
|
+
|
|
3227
|
+
- *Type:* `boolean`
|
|
3228
|
+
- *Default:* false
|
|
3229
|
+
|
|
3230
|
+
Setup prettier.
|
|
3231
|
+
|
|
3232
|
+
---
|
|
3233
|
+
|
|
3234
|
+
##### `prettierOptions`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.prettierOptions"></a>
|
|
3235
|
+
|
|
3236
|
+
```typescript
|
|
3237
|
+
public readonly prettierOptions: PrettierOptions;
|
|
3238
|
+
```
|
|
3239
|
+
|
|
3240
|
+
- *Type:* [`projen.javascript.PrettierOptions`](#projen.javascript.PrettierOptions)
|
|
3241
|
+
- *Default:* default options
|
|
3242
|
+
|
|
3243
|
+
Prettier options.
|
|
3244
|
+
|
|
3245
|
+
---
|
|
3246
|
+
|
|
3247
|
+
##### `projenDevDependency`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.projenDevDependency"></a>
|
|
3248
|
+
|
|
3249
|
+
```typescript
|
|
3250
|
+
public readonly projenDevDependency: boolean;
|
|
3251
|
+
```
|
|
3252
|
+
|
|
3253
|
+
- *Type:* `boolean`
|
|
3254
|
+
- *Default:* true
|
|
3255
|
+
|
|
3256
|
+
Indicates of "projen" should be installed as a devDependency.
|
|
3257
|
+
|
|
3258
|
+
---
|
|
3259
|
+
|
|
3260
|
+
##### `projenrcJs`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.projenrcJs"></a>
|
|
3261
|
+
|
|
3262
|
+
```typescript
|
|
3263
|
+
public readonly projenrcJs: boolean;
|
|
3264
|
+
```
|
|
3265
|
+
|
|
3266
|
+
- *Type:* `boolean`
|
|
3267
|
+
- *Default:* true if projenrcJson is false
|
|
3268
|
+
|
|
3269
|
+
Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.
|
|
3270
|
+
|
|
3271
|
+
---
|
|
3272
|
+
|
|
3273
|
+
##### `projenrcJsOptions`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.projenrcJsOptions"></a>
|
|
3274
|
+
|
|
3275
|
+
```typescript
|
|
3276
|
+
public readonly projenrcJsOptions: ProjenrcOptions;
|
|
3277
|
+
```
|
|
3278
|
+
|
|
3279
|
+
- *Type:* [`projen.javascript.ProjenrcOptions`](#projen.javascript.ProjenrcOptions)
|
|
3280
|
+
- *Default:* default options
|
|
3281
|
+
|
|
3282
|
+
Options for .projenrc.js.
|
|
3283
|
+
|
|
3284
|
+
---
|
|
3285
|
+
|
|
3286
|
+
##### `projenVersion`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.projenVersion"></a>
|
|
3287
|
+
|
|
3288
|
+
```typescript
|
|
3289
|
+
public readonly projenVersion: string;
|
|
3290
|
+
```
|
|
3291
|
+
|
|
3292
|
+
- *Type:* `string`
|
|
3293
|
+
- *Default:* Defaults to the latest version.
|
|
3294
|
+
|
|
3295
|
+
Version of projen to install.
|
|
3296
|
+
|
|
3297
|
+
---
|
|
3298
|
+
|
|
3299
|
+
##### `pullRequestTemplate`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.pullRequestTemplate"></a>
|
|
3300
|
+
|
|
3301
|
+
```typescript
|
|
3302
|
+
public readonly pullRequestTemplate: boolean;
|
|
3303
|
+
```
|
|
3304
|
+
|
|
3305
|
+
- *Type:* `boolean`
|
|
3306
|
+
- *Default:* true
|
|
3307
|
+
|
|
3308
|
+
Include a GitHub pull request template.
|
|
3309
|
+
|
|
3310
|
+
---
|
|
3311
|
+
|
|
3312
|
+
##### `pullRequestTemplateContents`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.pullRequestTemplateContents"></a>
|
|
3313
|
+
|
|
3314
|
+
```typescript
|
|
3315
|
+
public readonly pullRequestTemplateContents: string[];
|
|
3316
|
+
```
|
|
3317
|
+
|
|
3318
|
+
- *Type:* `string`[]
|
|
3319
|
+
- *Default:* default content
|
|
3320
|
+
|
|
3321
|
+
The contents of the pull request template.
|
|
3322
|
+
|
|
3323
|
+
---
|
|
3324
|
+
|
|
3325
|
+
##### `release`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.release"></a>
|
|
3326
|
+
|
|
3327
|
+
```typescript
|
|
3328
|
+
public readonly release: boolean;
|
|
3329
|
+
```
|
|
3330
|
+
|
|
3331
|
+
- *Type:* `boolean`
|
|
3332
|
+
- *Default:* true (false for subprojects)
|
|
3333
|
+
|
|
3334
|
+
Add release management to this project.
|
|
3335
|
+
|
|
3336
|
+
---
|
|
3337
|
+
|
|
3338
|
+
##### `releaseToNpm`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.releaseToNpm"></a>
|
|
3339
|
+
|
|
3340
|
+
```typescript
|
|
3341
|
+
public readonly releaseToNpm: boolean;
|
|
3342
|
+
```
|
|
3343
|
+
|
|
3344
|
+
- *Type:* `boolean`
|
|
3345
|
+
- *Default:* false
|
|
3346
|
+
|
|
3347
|
+
Automatically release to npm when new versions are introduced.
|
|
3348
|
+
|
|
3349
|
+
---
|
|
3350
|
+
|
|
3351
|
+
##### ~~`releaseWorkflow`~~<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.releaseWorkflow"></a>
|
|
3352
|
+
|
|
3353
|
+
- *Deprecated:* see `release`.
|
|
3354
|
+
|
|
3355
|
+
```typescript
|
|
3356
|
+
public readonly releaseWorkflow: boolean;
|
|
3357
|
+
```
|
|
3358
|
+
|
|
3359
|
+
- *Type:* `boolean`
|
|
3360
|
+
- *Default:* true if not a subproject
|
|
3361
|
+
|
|
3362
|
+
DEPRECATED: renamed to `release`.
|
|
3363
|
+
|
|
3364
|
+
---
|
|
3365
|
+
|
|
3366
|
+
##### `workflowBootstrapSteps`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.workflowBootstrapSteps"></a>
|
|
3367
|
+
|
|
3368
|
+
```typescript
|
|
3369
|
+
public readonly workflowBootstrapSteps: JobStep[];
|
|
3370
|
+
```
|
|
3371
|
+
|
|
3372
|
+
- *Type:* [`projen.github.workflows.JobStep`](#projen.github.workflows.JobStep)[]
|
|
3373
|
+
- *Default:* "yarn install --frozen-lockfile && yarn projen"
|
|
3374
|
+
|
|
3375
|
+
Workflow steps to use in order to bootstrap this repo.
|
|
3376
|
+
|
|
3377
|
+
---
|
|
3378
|
+
|
|
3379
|
+
##### `workflowGitIdentity`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.workflowGitIdentity"></a>
|
|
3380
|
+
|
|
3381
|
+
```typescript
|
|
3382
|
+
public readonly workflowGitIdentity: GitIdentity;
|
|
3383
|
+
```
|
|
3384
|
+
|
|
3385
|
+
- *Type:* [`projen.github.GitIdentity`](#projen.github.GitIdentity)
|
|
3386
|
+
- *Default:* GitHub Actions
|
|
3387
|
+
|
|
3388
|
+
The git identity to use in workflows.
|
|
3389
|
+
|
|
3390
|
+
---
|
|
3391
|
+
|
|
3392
|
+
##### `workflowNodeVersion`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.workflowNodeVersion"></a>
|
|
3393
|
+
|
|
3394
|
+
```typescript
|
|
3395
|
+
public readonly workflowNodeVersion: string;
|
|
3396
|
+
```
|
|
3397
|
+
|
|
3398
|
+
- *Type:* `string`
|
|
3399
|
+
- *Default:* same as `minNodeVersion`
|
|
3400
|
+
|
|
3401
|
+
The node version to use in GitHub workflows.
|
|
3402
|
+
|
|
3403
|
+
---
|
|
3404
|
+
|
|
3405
|
+
##### `docgen`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.docgen"></a>
|
|
3406
|
+
|
|
3407
|
+
```typescript
|
|
3408
|
+
public readonly docgen: boolean;
|
|
3409
|
+
```
|
|
3410
|
+
|
|
3411
|
+
- *Type:* `boolean`
|
|
3412
|
+
- *Default:* false
|
|
3413
|
+
|
|
3414
|
+
Docgen by Typedoc.
|
|
3415
|
+
|
|
3416
|
+
---
|
|
3417
|
+
|
|
3418
|
+
##### `docsDirectory`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.docsDirectory"></a>
|
|
3419
|
+
|
|
3420
|
+
```typescript
|
|
3421
|
+
public readonly docsDirectory: string;
|
|
3422
|
+
```
|
|
3423
|
+
|
|
3424
|
+
- *Type:* `string`
|
|
3425
|
+
- *Default:* "docs"
|
|
3426
|
+
|
|
3427
|
+
Docs directory.
|
|
3428
|
+
|
|
3429
|
+
---
|
|
3430
|
+
|
|
3431
|
+
##### `independentMode`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.independentMode"></a>
|
|
3432
|
+
|
|
3433
|
+
```typescript
|
|
3434
|
+
public readonly independentMode: boolean;
|
|
3435
|
+
```
|
|
3436
|
+
|
|
3437
|
+
- *Type:* `boolean`
|
|
3438
|
+
- *Default:* false
|
|
3439
|
+
|
|
3440
|
+
Whether or not to use independent versioning for sub-projects https://lerna.js.org/docs/features/version-and-publish#independent-mode.
|
|
3441
|
+
|
|
3442
|
+
---
|
|
3443
|
+
|
|
3444
|
+
##### `projenrcTs`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.projenrcTs"></a>
|
|
3445
|
+
|
|
3446
|
+
```typescript
|
|
3447
|
+
public readonly projenrcTs: boolean;
|
|
3448
|
+
```
|
|
3449
|
+
|
|
3450
|
+
- *Type:* `boolean`
|
|
3451
|
+
- *Default:* false
|
|
3452
|
+
|
|
3453
|
+
Use TypeScript for your projenrc file (`.projenrc.ts`).
|
|
3454
|
+
|
|
3455
|
+
---
|
|
3456
|
+
|
|
3457
|
+
##### `sinceLastRelease`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.sinceLastRelease"></a>
|
|
3458
|
+
|
|
3459
|
+
```typescript
|
|
3460
|
+
public readonly sinceLastRelease: boolean;
|
|
3461
|
+
```
|
|
3462
|
+
|
|
3463
|
+
- *Type:* `boolean`
|
|
3464
|
+
- *Default:* false
|
|
3465
|
+
|
|
3466
|
+
(experimental) Flag to run tasks only for the packages that has changes since last release.
|
|
3467
|
+
|
|
3468
|
+
---
|
|
3469
|
+
|
|
3470
|
+
##### `useNx`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.useNx"></a>
|
|
3471
|
+
|
|
3472
|
+
```typescript
|
|
3473
|
+
public readonly useNx: boolean;
|
|
3474
|
+
```
|
|
3475
|
+
|
|
3476
|
+
- *Type:* `boolean`
|
|
3477
|
+
- *Default:* false
|
|
3478
|
+
|
|
3479
|
+
Whether or not to use Nx for task scheduling https://lerna.js.org/docs/lerna-and-nx.
|
|
3480
|
+
|
|
3481
|
+
---
|
|
3482
|
+
|
|
3483
|
+
##### `useWorkspaces`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.useWorkspaces"></a>
|
|
3484
|
+
|
|
3485
|
+
```typescript
|
|
3486
|
+
public readonly useWorkspaces: boolean;
|
|
3487
|
+
```
|
|
3488
|
+
|
|
3489
|
+
- *Type:* `boolean`
|
|
3490
|
+
- *Default:* false
|
|
3491
|
+
|
|
3492
|
+
Whether or not to use workspaces in the package.json file Otherwise, will add packages to lerna.json.
|
|
3493
|
+
|
|
3494
|
+
---
|
|
3495
|
+
|
|
3496
|
+
##### `disableTsconfig`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.disableTsconfig"></a>
|
|
3497
|
+
|
|
3498
|
+
```typescript
|
|
3499
|
+
public readonly disableTsconfig: boolean;
|
|
3500
|
+
```
|
|
3501
|
+
|
|
3502
|
+
- *Type:* `boolean`
|
|
3503
|
+
- *Default:* false
|
|
3504
|
+
|
|
3505
|
+
Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
|
|
3506
|
+
|
|
3507
|
+
---
|
|
3508
|
+
|
|
3509
|
+
##### `entrypointTypes`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.entrypointTypes"></a>
|
|
3510
|
+
|
|
3511
|
+
```typescript
|
|
3512
|
+
public readonly entrypointTypes: string;
|
|
3513
|
+
```
|
|
3514
|
+
|
|
3515
|
+
- *Type:* `string`
|
|
3516
|
+
- *Default:* .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
|
|
3517
|
+
|
|
3518
|
+
The .d.ts file that includes the type declarations for this module.
|
|
3519
|
+
|
|
3520
|
+
---
|
|
3521
|
+
|
|
3522
|
+
##### `eslint`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.eslint"></a>
|
|
3523
|
+
|
|
3524
|
+
```typescript
|
|
3525
|
+
public readonly eslint: boolean;
|
|
3526
|
+
```
|
|
3527
|
+
|
|
3528
|
+
- *Type:* `boolean`
|
|
3529
|
+
- *Default:* true
|
|
3530
|
+
|
|
3531
|
+
Setup eslint.
|
|
3532
|
+
|
|
3533
|
+
---
|
|
3534
|
+
|
|
3535
|
+
##### `eslintOptions`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.eslintOptions"></a>
|
|
3536
|
+
|
|
3537
|
+
```typescript
|
|
3538
|
+
public readonly eslintOptions: EslintOptions;
|
|
3539
|
+
```
|
|
3540
|
+
|
|
3541
|
+
- *Type:* [`projen.javascript.EslintOptions`](#projen.javascript.EslintOptions)
|
|
3542
|
+
- *Default:* opinionated default options
|
|
3543
|
+
|
|
3544
|
+
Eslint options.
|
|
3545
|
+
|
|
3546
|
+
---
|
|
3547
|
+
|
|
3548
|
+
##### `libdir`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.libdir"></a>
|
|
3549
|
+
|
|
3550
|
+
```typescript
|
|
3551
|
+
public readonly libdir: string;
|
|
3552
|
+
```
|
|
3553
|
+
|
|
3554
|
+
- *Type:* `string`
|
|
3555
|
+
- *Default:* "lib"
|
|
3556
|
+
|
|
3557
|
+
Typescript artifacts output directory.
|
|
3558
|
+
|
|
3559
|
+
---
|
|
3560
|
+
|
|
3561
|
+
##### `projenrcTsOptions`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.projenrcTsOptions"></a>
|
|
3562
|
+
|
|
3563
|
+
```typescript
|
|
3564
|
+
public readonly projenrcTsOptions: ProjenrcOptions;
|
|
3565
|
+
```
|
|
3566
|
+
|
|
3567
|
+
- *Type:* [`projen.typescript.ProjenrcOptions`](#projen.typescript.ProjenrcOptions)
|
|
3568
|
+
|
|
3569
|
+
Options for .projenrc.ts.
|
|
3570
|
+
|
|
3571
|
+
---
|
|
3572
|
+
|
|
3573
|
+
##### `sampleCode`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.sampleCode"></a>
|
|
3574
|
+
|
|
3575
|
+
```typescript
|
|
3576
|
+
public readonly sampleCode: boolean;
|
|
3577
|
+
```
|
|
3578
|
+
|
|
3579
|
+
- *Type:* `boolean`
|
|
3580
|
+
- *Default:* true
|
|
3581
|
+
|
|
3582
|
+
Generate one-time sample in `src/` and `test/` if there are no files there.
|
|
3583
|
+
|
|
3584
|
+
---
|
|
3585
|
+
|
|
3586
|
+
##### `srcdir`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.srcdir"></a>
|
|
3587
|
+
|
|
3588
|
+
```typescript
|
|
3589
|
+
public readonly srcdir: string;
|
|
3590
|
+
```
|
|
3591
|
+
|
|
3592
|
+
- *Type:* `string`
|
|
3593
|
+
- *Default:* "src"
|
|
3594
|
+
|
|
3595
|
+
Typescript sources directory.
|
|
3596
|
+
|
|
3597
|
+
---
|
|
3598
|
+
|
|
3599
|
+
##### `testdir`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.testdir"></a>
|
|
3600
|
+
|
|
3601
|
+
```typescript
|
|
3602
|
+
public readonly testdir: string;
|
|
3603
|
+
```
|
|
3604
|
+
|
|
3605
|
+
- *Type:* `string`
|
|
3606
|
+
- *Default:* "test"
|
|
3607
|
+
|
|
3608
|
+
Jest tests directory. Tests files should be named `xxx.test.ts`.
|
|
3609
|
+
|
|
3610
|
+
If this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`),
|
|
3611
|
+
then tests are going to be compiled into `lib/` and executed as javascript.
|
|
3612
|
+
If the test directory is outside of `src`, then we configure jest to
|
|
3613
|
+
compile the code in-memory.
|
|
3614
|
+
|
|
3615
|
+
---
|
|
3616
|
+
|
|
3617
|
+
##### `tsconfig`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.tsconfig"></a>
|
|
3618
|
+
|
|
3619
|
+
```typescript
|
|
3620
|
+
public readonly tsconfig: TypescriptConfigOptions;
|
|
3621
|
+
```
|
|
3622
|
+
|
|
3623
|
+
- *Type:* [`projen.javascript.TypescriptConfigOptions`](#projen.javascript.TypescriptConfigOptions)
|
|
3624
|
+
- *Default:* default options
|
|
3625
|
+
|
|
3626
|
+
Custom TSConfig.
|
|
3627
|
+
|
|
3628
|
+
---
|
|
3629
|
+
|
|
3630
|
+
##### `tsconfigDev`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.tsconfigDev"></a>
|
|
3631
|
+
|
|
3632
|
+
```typescript
|
|
3633
|
+
public readonly tsconfigDev: TypescriptConfigOptions;
|
|
3634
|
+
```
|
|
3635
|
+
|
|
3636
|
+
- *Type:* [`projen.javascript.TypescriptConfigOptions`](#projen.javascript.TypescriptConfigOptions)
|
|
3637
|
+
- *Default:* use the production tsconfig options
|
|
3638
|
+
|
|
3639
|
+
Custom tsconfig options for the development tsconfig.json file (used for testing).
|
|
3640
|
+
|
|
3641
|
+
---
|
|
3642
|
+
|
|
3643
|
+
##### `tsconfigDevFile`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.tsconfigDevFile"></a>
|
|
3644
|
+
|
|
3645
|
+
```typescript
|
|
3646
|
+
public readonly tsconfigDevFile: string;
|
|
3647
|
+
```
|
|
3648
|
+
|
|
3649
|
+
- *Type:* `string`
|
|
3650
|
+
- *Default:* "tsconfig.dev.json"
|
|
3651
|
+
|
|
3652
|
+
The name of the development tsconfig.json file.
|
|
3653
|
+
|
|
3654
|
+
---
|
|
3655
|
+
|
|
3656
|
+
##### `typescriptVersion`<sup>Optional</sup> <a name="lerna-projen.LernaTypescriptProjectOptions.property.typescriptVersion"></a>
|
|
3657
|
+
|
|
3658
|
+
```typescript
|
|
3659
|
+
public readonly typescriptVersion: string;
|
|
3660
|
+
```
|
|
3661
|
+
|
|
3662
|
+
- *Type:* `string`
|
|
3663
|
+
- *Default:* "latest"
|
|
3664
|
+
|
|
3665
|
+
TypeScript version to use.
|
|
3666
|
+
|
|
3667
|
+
NOTE: Typescript is not semantically versioned and should remain on the
|
|
3668
|
+
same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`).
|
|
3669
|
+
|
|
3670
|
+
---
|
|
3671
|
+
|
|
1751
3672
|
## Classes <a name="Classes"></a>
|
|
1752
3673
|
|
|
1753
3674
|
### LernaProject <a name="lerna-projen.LernaProject"></a>
|
|
@@ -1771,10 +3692,10 @@ new LernaProject(options: LernaProjectOptions)
|
|
|
1771
3692
|
##### ~~`addSubProject`~~ <a name="lerna-projen.LernaProject.addSubProject"></a>
|
|
1772
3693
|
|
|
1773
3694
|
```typescript
|
|
1774
|
-
public addSubProject(
|
|
3695
|
+
public addSubProject(_subproject: Project)
|
|
1775
3696
|
```
|
|
1776
3697
|
|
|
1777
|
-
###### `
|
|
3698
|
+
###### `_subproject`<sup>Required</sup> <a name="lerna-projen.LernaProject.parameter._subproject"></a>
|
|
1778
3699
|
|
|
1779
3700
|
- *Type:* [`projen.Project`](#projen.Project)
|
|
1780
3701
|
|
|
@@ -1850,4 +3771,72 @@ public readonly useWorkspaces: boolean;
|
|
|
1850
3771
|
---
|
|
1851
3772
|
|
|
1852
3773
|
|
|
3774
|
+
### LernaTypescriptProject <a name="lerna-projen.LernaTypescriptProject"></a>
|
|
3775
|
+
|
|
3776
|
+
#### Initializers <a name="lerna-projen.LernaTypescriptProject.Initializer"></a>
|
|
3777
|
+
|
|
3778
|
+
```typescript
|
|
3779
|
+
import { LernaTypescriptProject } from 'lerna-projen'
|
|
3780
|
+
|
|
3781
|
+
new LernaTypescriptProject(options: LernaTypescriptProjectOptions)
|
|
3782
|
+
```
|
|
3783
|
+
|
|
3784
|
+
##### `options`<sup>Required</sup> <a name="lerna-projen.LernaTypescriptProject.parameter.options"></a>
|
|
3785
|
+
|
|
3786
|
+
- *Type:* [`lerna-projen.LernaTypescriptProjectOptions`](#lerna-projen.LernaTypescriptProjectOptions)
|
|
3787
|
+
|
|
3788
|
+
---
|
|
3789
|
+
|
|
3790
|
+
#### Methods <a name="Methods"></a>
|
|
3791
|
+
|
|
3792
|
+
##### `preSynthesize` <a name="lerna-projen.LernaTypescriptProject.preSynthesize"></a>
|
|
3793
|
+
|
|
3794
|
+
```typescript
|
|
3795
|
+
public preSynthesize()
|
|
3796
|
+
```
|
|
3797
|
+
|
|
3798
|
+
|
|
3799
|
+
#### Properties <a name="Properties"></a>
|
|
3800
|
+
|
|
3801
|
+
##### `independentMode`<sup>Required</sup> <a name="lerna-projen.LernaTypescriptProject.property.independentMode"></a>
|
|
3802
|
+
|
|
3803
|
+
```typescript
|
|
3804
|
+
public readonly independentMode: boolean;
|
|
3805
|
+
```
|
|
3806
|
+
|
|
3807
|
+
- *Type:* `boolean`
|
|
3808
|
+
|
|
3809
|
+
---
|
|
3810
|
+
|
|
3811
|
+
##### `sinceLastRelease`<sup>Required</sup> <a name="lerna-projen.LernaTypescriptProject.property.sinceLastRelease"></a>
|
|
3812
|
+
|
|
3813
|
+
```typescript
|
|
3814
|
+
public readonly sinceLastRelease: boolean;
|
|
3815
|
+
```
|
|
3816
|
+
|
|
3817
|
+
- *Type:* `boolean`
|
|
3818
|
+
|
|
3819
|
+
---
|
|
3820
|
+
|
|
3821
|
+
##### `useNx`<sup>Required</sup> <a name="lerna-projen.LernaTypescriptProject.property.useNx"></a>
|
|
3822
|
+
|
|
3823
|
+
```typescript
|
|
3824
|
+
public readonly useNx: boolean;
|
|
3825
|
+
```
|
|
3826
|
+
|
|
3827
|
+
- *Type:* `boolean`
|
|
3828
|
+
|
|
3829
|
+
---
|
|
3830
|
+
|
|
3831
|
+
##### `useWorkspaces`<sup>Required</sup> <a name="lerna-projen.LernaTypescriptProject.property.useWorkspaces"></a>
|
|
3832
|
+
|
|
3833
|
+
```typescript
|
|
3834
|
+
public readonly useWorkspaces: boolean;
|
|
3835
|
+
```
|
|
3836
|
+
|
|
3837
|
+
- *Type:* `boolean`
|
|
3838
|
+
|
|
3839
|
+
---
|
|
3840
|
+
|
|
3841
|
+
|
|
1853
3842
|
|