Skip to content

Commit 9629039

Browse files
committed
Spring cleaning
1 parent 62f1519 commit 9629039

File tree

68 files changed

+2783
-7873
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+2783
-7873
lines changed

.eslintrc.json

Lines changed: 0 additions & 91 deletions
This file was deleted.

.github/workflows/build.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,21 +25,21 @@ jobs:
2525
with:
2626
node-version: ${{ matrix.node-version }}
2727

28-
- name: Install yarn
29-
run: npm install -g yarn
28+
- name: Install pnpm
29+
run: npm install -g pnpm
3030

3131
- name: Install dependencies
3232
run: |
33-
yarn
33+
pnpm install
3434
3535
- name: Lint
3636
run: |
37-
yarn lint
37+
pnpm run lint
3838
3939
- name: Build
4040
run: |
41-
yarn build
41+
pnpm run build
4242
4343
- name: Test
4444
run: |
45-
yarn test
45+
pnpm run test

.github/workflows/publish.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,24 +21,24 @@ jobs:
2121
with:
2222
node-version: ${{ matrix.node-version }}
2323

24-
- name: Install yarn
25-
run: npm install -g yarn
24+
- name: Install pnpm
25+
run: npm install -g pnpm
2626

2727
- name: Install dependencies
2828
run: |
29-
yarn
29+
pnpm install
3030
3131
- name: Lint
3232
run: |
33-
yarn lint
33+
pnpm run lint
3434
3535
- name: Build
3636
run: |
37-
yarn build
37+
pnpm run build
3838
3939
- name: Test
4040
run: |
41-
yarn test
41+
pnpm run test
4242
4343
- name: Publish
4444
run: |

.prettierrc.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
{
22
"proseWrap": "always",
3-
"printWidth": 200,
43
"tabWidth": 4
54
}

AUTHORS

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
1-
# This is the official list of regular_table authors for copyright purposes.
2-
3-
Andrew Stein <steinlink@gmail.com>
4-
Joshua Hawkins <josh.r.hawk@gmail.com>
5-
JP Morgan Chase
6-
Max Klein <telamonian@hotmail.com>
7-
Tim Paine <t.paine154@gmail.com>
1+
295 Andrew Stein <steinlink@gmail.com>
2+
6 Debajit Datta <debajit.datta2000@gmail.com>
3+
54 Joshua Hawkins <josh.r.hawk@gmail.com>
4+
6 Joshua Hawkins <joshua.r.hawkins@jpmchase.com>
5+
3 Juan Estrella <juan.estrella@finos.org>
6+
1 Lavakush biyani <70131581+lavakush07@users.noreply.github.com>
7+
2 Minh Nguyen <2852660+NMinhNguyen@users.noreply.github.com>
8+
1 Neil Slinger <neil.slinger@gmail.com>
9+
1 Patricio Mancini <patricio.mancini@gmail.com>
10+
13 Tim Paine <t.paine154@gmail.com>
11+
2 jpmtrm <75507096+jpmtrm@users.noreply.github.com>
12+
45 telamonian <telamonian@users.noreply.github.com>

CONTRIBUTING.md

Lines changed: 81 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,122 @@
1-
# Contributing
1+
# Contributing
22

33
Thank you for your interest in contributing to `regular-table`!
44

5-
`regular-table` is built on open source and hosted by the Fintech Open Source Foundation (FINOS). We invite you to participate in our community by adding and commenting on [issues](https://github.com/finos/regular-table/issues) (e.g., bug reports; new feature suggestions) or contributing code enhancements through a pull request.
6-
7-
Note that commits and pull requests to FINOS repositories such as `regular-table` may only be accepted from those contributors with a [Contributor License Agreement (CLA)](https://finosfoundation.atlassian.net/wiki/spaces/FINOS/pages/75530375/Contribution+Compliance+Requirements#ContributionComplianceRequirements-ContributorLicenseAgreement) with FINOS. This may take the form of either:
8-
* an active, executed Individual Contributor License Agreement (ICLA) with FINOS, OR
9-
* coverage under an existing, active Corporate Contribution License Agreement (CCLA) executed with FINOS (most likely by the developer's employer). Please note that some, though not all, CCLAs require individuals/employees to be explicitly named on the CCLA.
10-
11-
Commits from individuals not covered under an CLA can not be merged by `regular-table`'s committers. We encourage you to check that you have a CLA in place well in advance of making your first pull request.
12-
13-
Need an ICLA? Unsure if you are covered under an existing CCLA? Confused? Email [help@finos.org](mailto:help@finos.org) and the foundation team will help get it sorted out for you.
14-
15-
If you have any general questions about contributing to `regular-table`, please feel free to open an issue on [github](https://github.com/finos/regular-table/issues/new), or email [help@finos.org](mailto:finos.org).
5+
`regular-table` is built on open source and hosted by the Fintech Open Source
6+
Foundation (FINOS). We invite you to participate in our community by adding and
7+
commenting on [issues](https://github.com/finos/regular-table/issues) (e.g., bug
8+
reports; new feature suggestions) or contributing code enhancements through a
9+
pull request.
10+
11+
Note that commits and pull requests to FINOS repositories such as
12+
`regular-table` may only be accepted from those contributors with a
13+
[Contributor License Agreement (CLA)](https://finosfoundation.atlassian.net/wiki/spaces/FINOS/pages/75530375/Contribution+Compliance+Requirements#ContributionComplianceRequirements-ContributorLicenseAgreement)
14+
with FINOS. This may take the form of either:
15+
16+
- an active, executed Individual Contributor License Agreement (ICLA) with
17+
FINOS, OR
18+
- coverage under an existing, active Corporate Contribution License Agreement
19+
(CCLA) executed with FINOS (most likely by the developer's employer). Please
20+
note that some, though not all, CCLAs require individuals/employees to be
21+
explicitly named on the CCLA.
22+
23+
Commits from individuals not covered under an CLA can not be merged by
24+
`regular-table`'s committers. We encourage you to check that you have a CLA in
25+
place well in advance of making your first pull request.
26+
27+
Need an ICLA? Unsure if you are covered under an existing CCLA? Confused? Email
28+
[help@finos.org](mailto:help@finos.org) and the foundation team will help get it
29+
sorted out for you.
30+
31+
If you have any general questions about contributing to `regular-table`, please
32+
feel free to open an issue on
33+
[github](https://github.com/finos/regular-table/issues/new), or email
34+
[help@finos.org](mailto:finos.org).
1635

1736
## Guidelines
1837

1938
When submitting PRs to `regular-table`, please respect the following general
2039
coding guidelines:
2140

22-
* Please try to keep PRs small and focused. If you find your PR touches multiple loosely related changes, it may be best to break up into multiple PRs.
23-
* Individual commits should preferably do One Thing (tm), and have descriptive commit messages. Do not make "WIP" or other mystery commit messages.
24-
* ... that being said, one-liners or other commits should typically be grouped. Please try to keep 'cleanup', 'formatting' or other non-functional changes to a single commit at most in your PR.
25-
* PRs that involve moving files around the repository tree should be organized in a stand-alone commit from actual code changes.
26-
* Please do not submit incomplete PRs or partially implemented features. Feature additions should be implemented completely. If your PR is a build, documentation, test change, or an API change that is not applicable to the UX, please explain this in the comments.
27-
* Please do not submit PRs disabled by feature or build flag - experimental features should be kept on a branch until they are ready to be merged.
28-
* Feature additions, make sure you have added complete JSDoc to any new APIs, as well as additions to the [Usage Guide]() if applicable.
29-
* All PRs should be accompanied by tests asserting their behavior in any packages they modify.
30-
* Do not commit with `--no-verify` or otherwise bypass commit hooks, and please respect the formatting and linting guidelines they enforce.
31-
* Do not `merge master` upstream changes into your PR. If your change has conflicts with the `master` branch, please pull master into your fork's master, then rebase.
41+
- Please try to keep PRs small and focused. If you find your PR touches
42+
multiple loosely related changes, it may be best to break up into multiple
43+
PRs.
44+
- Individual commits should preferably do One Thing (tm), and have descriptive
45+
commit messages. Do not make "WIP" or other mystery commit messages.
46+
- ... that being said, one-liners or other commits should typically be
47+
grouped. Please try to keep 'cleanup', 'formatting' or other non-functional
48+
changes to a single commit at most in your PR.
49+
- PRs that involve moving files around the repository tree should be organized
50+
in a stand-alone commit from actual code changes.
51+
- Please do not submit incomplete PRs or partially implemented features.
52+
Feature additions should be implemented completely. If your PR is a build,
53+
documentation, test change, or an API change that is not applicable to the
54+
UX, please explain this in the comments.
55+
- Please do not submit PRs disabled by feature or build flag - experimental
56+
features should be kept on a branch until they are ready to be merged.
57+
- Feature additions, make sure you have added complete JSDoc to any new APIs,
58+
as well as additions to the [Usage Guide]() if applicable.
59+
- All PRs should be accompanied by tests asserting their behavior in any
60+
packages they modify.
61+
- Do not commit with `--no-verify` or otherwise bypass commit hooks, and
62+
please respect the formatting and linting guidelines they enforce.
63+
- Do not `merge master` upstream changes into your PR. If your change has
64+
conflicts with the `master` branch, please pull master into your fork's
65+
master, then rebase.
3266

3367
## Contribution Process
3468

3569
Before making a contribution, please take the following steps:
36-
1. Check whether there's already an open issue related to your proposed contribution. If there is, join the discussion and propose your contribution there.
37-
2. If there isn't already a relevant issue, create one, describing your contribution and the problem you're trying to solve.
38-
3. Respond to any questions or suggestions raised in the issue by other developers.
70+
71+
1. Check whether there's already an open issue related to your proposed
72+
contribution. If there is, join the discussion and propose your contribution
73+
there.
74+
2. If there isn't already a relevant issue, create one, describing your
75+
contribution and the problem you're trying to solve.
76+
3. Respond to any questions or suggestions raised in the issue by other
77+
developers.
3978
4. Fork the project repository and prepare your proposed contribution.
4079
5. Submit a pull request.
4180

42-
NOTE: All contributors must have a contributor license agreement (CLA) on file with FINOS before their pull requests will be merged. Please review the FINOS [contribution requirements](https://community.finos.org/docs/governance/Software-Projects/contribution-compliance-requirements) and submit (or have your employer submit) the required CLA before submitting a pull request.
43-
81+
NOTE: All contributors must have a contributor license agreement (CLA) on file
82+
with FINOS before their pull requests will be merged. Please review the FINOS
83+
[contribution requirements](https://community.finos.org/docs/governance/Software-Projects/contribution-compliance-requirements)
84+
and submit (or have your employer submit) the required CLA before submitting a
85+
pull request.
4486

4587
## Development install
4688

4789
First install `dev_dependencies`:
4890

4991
```bash
50-
yarn
92+
pnpm install
5193
```
5294

5395
Build the library
5496

5597
```bash
56-
yarn build
98+
pnpm run build
5799
```
58100

59101
Run the test suite
60102

61103
```bash
62-
yarn test
104+
pnpm run test
63105
```
64106

65-
Start the example server at [`http://localhost:8080/examples/`](http://localhost:8080/examples/)
107+
Start the example server at
108+
[`http://localhost:8080/examples/`](http://localhost:8080/examples/)
66109

67110
```bash
68-
yarn start
111+
pnpm run start
69112
```
70113

71114
## How to rebuild the Typescript declarations
72115

73116
### Step-by-step
74117

75118
1. For the duration of building declarations, temporarily `export` the
76-
`RegularTableElement` in `src/js/index.js`:
119+
`RegularTableElement` in `src/js/index.js`:
77120

78121
```javascript
79122
// TEMP: export keyword added for building declarations
@@ -83,7 +126,7 @@ export class RegularTableElement extends RegularViewEventModel {
83126
2. Run typescript declarations build:
84127
85128
```bash
86-
yarn declarations
129+
pnpm run declarations
87130
```
88131
89132
This will create `declarations/index.d.ts` and other typescript
@@ -102,5 +145,7 @@ with the contents of the just-built `declarations/index.d.ts`.
102145
103146
### Troubleshooting
104147
105-
If an update to index.d.ts is found to break the compilation of any downstream projects, a likely place to check for errors are the pure jsdoc typedefs in `src/js/index.js` below the RegularTableElement class defintion. Ensure that all of the described types are in sync with their current javascript counterparts.
106-
148+
If an update to index.d.ts is found to break the compilation of any downstream
149+
projects, a likely place to check for errors are the pure jsdoc typedefs in
150+
`src/js/index.js` below the RegularTableElement class defintion. Ensure that all
151+
of the described types are in sync with their current javascript counterparts.

NOTICE

Lines changed: 0 additions & 5 deletions
This file was deleted.

0 commit comments

Comments
 (0)