Skip to content

Commit c5c99eb

Browse files
committed
chore: sync project template changes
Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>
1 parent 3a4abcb commit c5c99eb

7 files changed

Lines changed: 41 additions & 49 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,5 +35,4 @@ A list of linked issues and/or pull requests.
3535
- [ ] new, **tolerable** vulnerabilities and/or warnings documented, if any
3636
- [ ] [pr naming conventions][1]
3737

38-
[1]:
39-
https://github.com/flex-development/aggregate-error-ponyfill/blob/main/CONTRIBUTING.md#pull-request-titles
38+
[1]: https://github.com/flex-development/aggregate-error-ponyfill/blob/main/CONTRIBUTING.md#pull-request-titles

.vscode/settings.json

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,8 @@
116116
"json",
117117
"jsonc",
118118
"markdown",
119-
"typescript"
119+
"typescript",
120+
"yaml"
120121
],
121122
"files.associations": {
122123
"*.snap": "jest-snapshot",
@@ -136,12 +137,7 @@
136137
"markdown.extension.toc.slugifyMode": "github",
137138
"markdown.extension.toc.updateOnSave": false,
138139
"npm-intellisense.scanDevDependencies": true,
139-
"prettier.configPath": "./.prettierrc.json",
140-
"prettier.enable": true,
141-
"prettier.ignorePath": "./.prettierignore",
142-
"prettier.prettierPath": "./node_modules/prettier",
143-
"prettier.resolveGlobalModules": false,
144-
"prettier.useEditorConfig": true,
140+
"prettier.enable": false,
145141
"shellformat.flag": "-ci -fn -i=2 -sr",
146142
"typescript.suggest.completeFunctionCalls": true,
147143
"typescript.suggest.completeJSDocs": true,
@@ -158,6 +154,11 @@
158154
"format": "svg",
159155
"icon": "graphql"
160156
},
157+
{
158+
"extensions": ["build.json"],
159+
"format": "svg",
160+
"icon": "tsconfig"
161+
},
161162
{
162163
"extensions": ["snap"],
163164
"format": "svg",
@@ -180,6 +181,11 @@
180181
"format": "svg",
181182
"icon": "temp"
182183
},
184+
{
185+
"extensions": ["patches"],
186+
"format": "svg",
187+
"icon": "include"
188+
},
183189
{
184190
"extensions": ["setup"],
185191
"format": "svg",

CONTRIBUTING.md

Lines changed: 23 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# Contributing Guide
22

3-
This document aims to describe the workflows and rules used for developing this
4-
project. This includes, but is not limited to:
3+
This document aims to describe the workflows and rules used for developing this project.
4+
5+
This includes, but is not limited to:
56

67
- how to contribute code (coding standards, testing, documenting source code)
78
- how pull requests are handled
@@ -47,12 +48,10 @@ Follow the steps below to setup your local development environment:
4748
yarn
4849
```
4950

50-
**Note**: This project uses [Yarn 2][3]. Consult [`.yarnrc.yml`](.yarnrc.yml)
51-
for an overview of configuration options and required environment variables.
52-
Furthermore, if you already have a global Yarn configuration, or any `YARN_*`
53-
environment variables set, an error will be thrown if any settings conflict
54-
with the project's Yarn configuration, or the Yarn 2 API. Missing environment
55-
variables will also yield an error.
51+
**Note**: This project uses [Yarn 2][3]. Consult [`.yarnrc.yml`](.yarnrc.yml) for an overview of configuration
52+
options and required environment variables. Furthermore, if you already have a global Yarn configuration, or any
53+
`YARN_*` environment variables set, an error will be thrown if any settings conflict with the project's Yarn
54+
configuration, or the Yarn 2 API. Missing environment variables will also yield an error.
5655

5756
7. [ZSH][4] setup
5857

@@ -115,11 +114,9 @@ See [`.github/.gitconfig`](.github/.gitconfig) for an exhaustive list.
115114

116115
## Contributing Code
117116

118-
[Husky][5] is used to locally enforce coding and commit message standards, as
119-
well as run tests pre-push.
117+
[Husky][5] is used to locally enforce coding and commit message standards, as well as run tests pre-push.
120118

121-
Any code merged into the [trunk](#branching-model) must confront the following
122-
criteria:
119+
Any code merged into the [trunk](#branching-model) must confront the following criteria:
123120

124121
- changes should be discussed prior to implementation
125122
- changes have been tested properly
@@ -128,8 +125,7 @@ criteria:
128125

129126
### Branching Model
130127

131-
This project follows a [Trunk Based Development][6] workflow, specifically the
132-
[short-lived branch style][7].
128+
This project follows a [Trunk Based Development][6] workflow, specifically the [short-lived branch style][7].
133129

134130
- Trunk Branch: `main`
135131
- Short-Lived Branches: `feat/*`, `hotfix/*`, `release/*`
@@ -152,8 +148,7 @@ When creating a new branch, the name should match the following format:
152148

153149
### Commit Messages
154150

155-
This project follows [Conventional Commit][8] standards and uses [commitlint][9]
156-
to enforce those standards.
151+
This project follows [Conventional Commit][8] standards and uses [commitlint][9] to enforce those standards.
157152

158153
This means every commit must conform to the following format:
159154

@@ -221,8 +216,7 @@ Source code is located in [`src`](src) directory.
221216

222217
- JavaScript & TypeScript: [JSDoc][12]; linted with [`eslint-plugin-jsdoc`][13]
223218

224-
Before making a pull request, be sure your code is well documented, as it will
225-
be part of your code review.
219+
Before making a pull request, be sure your code is well documented, as it will be part of your code review.
226220

227221
### Testing
228222

@@ -240,15 +234,14 @@ Be sure to use [`it.skip`][15] or [`it.todo`][16] where appropriate.
240234

241235
### Getting Help
242236

243-
If you need help, make note of any issues in their respective files in the form
244-
of a [JSDoc comment][12]. If you need help with a test, don't forget to use
245-
[`it.skip`][15] and/or [`it.todo`][16]. Afterwards, [start a discussion in the
237+
If you need help, make note of any issues in their respective files in the form of a [JSDoc comment][12]. If you need
238+
help with a test, don't forget to use [`it.skip`][15] and/or [`it.todo`][16]. Afterwards, [start a discussion in the
246239
Q&A category][17].
247240

248241
## Labels
249242

250-
This project uses a well-defined list of labels to organize issues and pull
251-
requests. Most labels are scoped (i.e: `status:`).
243+
This project uses a well-defined list of labels to organize issues and pull requests. Most labels are scoped (i.e:
244+
`status:`).
252245

253246
A list of labels can be found in [`.github/labels.yml`](.github/labels.yml).
254247

@@ -260,8 +253,7 @@ Before opening an issue, make sure you have:
260253
- checked that the issue hasn't already been filed by searching open issues
261254
- searched closed issues for solution(s) or feedback
262255

263-
If you haven't found a related open issue, or feel that a closed issue should be
264-
re-visited, open a new issue.
256+
If you haven't found a related open issue, or feel that a closed issue should be re-visited, open a new issue.
265257

266258
A well-written issue
267259

@@ -272,8 +264,7 @@ A well-written issue
272264

273265
## Pull Requests
274266

275-
When you're ready to submit your changes, open a pull request (PR) against
276-
`main`:
267+
When you're ready to submit your changes, open a pull request (PR) against `main`:
277268

278269
```sh
279270
https://github.com/flex-development/aggregate-error-ponyfill/compare/main...$branch
@@ -296,13 +287,12 @@ Every PR you open should:
296287

297288
### Pull Request Titles
298289

299-
To keep in line with [commit message standards](#commit-messages) after PRs are
300-
merged, PR titles are expected to adhere to the same rules.
290+
To keep in line with [commit message standards](#commit-messages) after PRs are merged, PR titles are expected to adhere
291+
to the same rules.
301292

302293
## Merge Strategies
303294

304-
In every repository, the `rebase and merge` and `squash and merge` options are
305-
enabled.
295+
In every repository, the `rebase and merge` and `squash and merge` options are enabled.
306296

307297
- **rebase and merge**: PR has one commit or commits that are not grouped
308298
- **squash and merge**: PR has one commit or a group of commits
@@ -333,8 +323,7 @@ e.g:
333323
## Deployment
334324

335325
> Note: Package and release publication is executed via GitHub workflow.\
336-
> This is so invalid or malicious versions cannot be published without merging those
337-
> changes into `main` first.
326+
> This is so invalid or malicious versions cannot be published without merging those changes into `main` first.
338327

339328
Before deploying, the following steps must be completed:
340329

@@ -366,8 +355,7 @@ Before deploying, the following steps must be completed:
366355
- create and publish github release
367356
- make sure all prereleased or released issues are closed
368357
- delete the release branch
369-
- on release publish, [publish workflow](.github/workflows/publish.yml)
370-
will fire
358+
- on release publish, [publish workflow](.github/workflows/publish.yml) will fire
371359
- if successful, the workflow will:
372360
- publish package to [github package registry][19]
373361
- publish package to [npm][20]

__tests__/interfaces/vi-assertion-result.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
* @module tests/interfaces/AssertionResult
44
*/
55

6-
import type { OrNull } from '@flex-development/tutils'
6+
import type { Nullable } from '@flex-development/tutils'
77

88
/**
99
* Test assertion summary object produced by the `vitest` [`JsonReporter`][1].
@@ -12,7 +12,7 @@ import type { OrNull } from '@flex-development/tutils'
1212
*/
1313
interface AssertionResult {
1414
ancestorTitles: string[]
15-
duration?: OrNull<number>
15+
duration?: Nullable<number>
1616
failureMessages: string[]
1717
fullName: string
1818
status: 'disabled' | 'failed' | 'passed' | 'pending' | 'skipped' | 'todo'

build.config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
* @file Build Config
33
* @module config/build
4-
* @see https://github.com/flex-development/mkbuild#configuration
4+
* @see https://github.com/flex-development/mkbuild
55
*/
66

77
import { defineBuildConfig, type Config } from '@flex-development/mkbuild'

tsconfig.build.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
{
22
"compilerOptions": {
3-
"isolatedModules": true,
43
"noEmitOnError": true,
54
"skipLibCheck": false,
65
"target": "es2020"

tsconfig.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
"experimentalDecorators": true,
1414
"forceConsistentCasingInFileNames": true,
1515
"importsNotUsedAsValues": "error",
16-
"isolatedModules": false,
16+
"isolatedModules": true,
1717
"lib": ["es2020"],
1818
"module": "esnext",
1919
"moduleDetection": "force",

0 commit comments

Comments
 (0)