griffithlab / civic-v2

CIViC is an open access, open source, community-driven web resource for Clinical Interpretation of Variants in Cancer
https://civicdb.org
MIT License
19 stars 5 forks source link

Add codespell: config, workflow (to detect new) + make it find/fix some existing typos #1028

Closed yarikoptic closed 2 months ago

yarikoptic commented 3 months ago
Note that I completely skipped `generated/` -- they do carry a good number of typos which can be easily fixed ```shell ❯ codespell **/generated client/src/app/generated/civic.apollo.ts:1008: irregardless ==> regardless client/src/app/generated/civic.apollo.ts:1450: occured ==> occurred client/src/app/generated/civic.apollo.ts:1464: irregardless ==> regardless client/src/app/generated/civic.apollo.ts:1857: irregardless ==> regardless client/src/app/generated/civic.apollo.ts:2597: submited ==> submitted client/src/app/generated/civic.apollo.ts:2700: erronously ==> erroneously client/src/app/generated/civic.apollo.ts:2729: currentlly ==> currently client/src/app/generated/civic.apollo.ts:3008: occured ==> occurred client/src/app/generated/civic.apollo.ts:4264: irregardless ==> regardless client/src/app/generated/civic.model.graphql:730: erronously ==> erroneously client/src/app/generated/civic.model.graphql:1368: reponse ==> response client/src/app/generated/civic.model.graphql:1378: certaint ==> certain client/src/app/generated/civic.model.graphql:1383: reponse ==> response client/src/app/generated/server.model.graphql:96: occured ==> occurred client/src/app/generated/server.model.graphql:133: irregardless ==> regardless client/src/app/generated/server.model.graphql:1684: irregardless ==> regardless client/src/app/generated/server.model.graphql:2296: occured ==> occurred client/src/app/generated/server.model.graphql:2327: irregardless ==> regardless client/src/app/generated/server.model.graphql:3002: irregardless ==> regardless client/src/app/generated/server.model.graphql:3691: reponse ==> response client/src/app/generated/server.model.graphql:3701: certaint ==> certain client/src/app/generated/server.model.graphql:3706: reponse ==> response client/src/app/generated/server.model.graphql:4321: submited ==> submitted client/src/app/generated/server.model.graphql:4550: erronously ==> erroneously client/src/app/generated/server.model.graphql:4682: currentlly ==> currently client/src/app/generated/server.model.graphql:4833: occured ==> occurred client/src/app/generated/server.model.graphql:5501: Columm ==> Column client/src/app/generated/server.model.graphql:6002: Columm ==> Column client/src/app/generated/server.model.graphql:6007: interal ==> internal, interval, integral client/src/app/generated/server.model.graphql:6153: involed ==> involved client/src/app/generated/server.model.graphql:6276: Columm ==> Column client/src/app/generated/server.model.graphql:6596: decending ==> descending client/src/app/generated/server.model.graphql:7041: irregardless ==> regardless client/src/app/generated/server.model.graphql:8587: reponse ==> response client/src/app/generated/server.model.graphql:8597: certaint ==> certain client/src/app/generated/server.model.graphql:8602: reponse ==> response client/src/app/generated/server.schema.json:721: occured ==> occurred client/src/app/generated/server.schema.json:11763: occured ==> occurred client/src/app/generated/server.schema.json:20877: submited ==> submitted client/src/app/generated/server.schema.json:21996: currentlly ==> currently client/src/app/generated/server.schema.json:23761: occured ==> occurred client/src/app/generated/server.schema.json:26408: Columm ==> Column client/src/app/generated/server.schema.json:28384: interal ==> internal, interval, integral client/src/app/generated/server.schema.json:28420: Columm ==> Column client/src/app/generated/server.schema.json:29276: Columm ==> Column client/src/app/generated/server.schema.json:30765: decending ==> descending ```

Should I or they should just be regenerated?

acoffman commented 2 months ago

Hi @yarikoptic

Thanks for your contribution (and sorry it took so long to review!).

I've made a couple of small changes, and then merged the latest main into this branch as there was a merge conflict that needed to be resolved. I've opened the merged version as a new PR #1042.

Note that I completely skipped generated/

Yep, this is the correct approach. Everything in that directory is derived from the codebase and rebuilt on deploy.