Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(deps-dev): move non-internal devDeps to root #3139

Merged
merged 11 commits into from
Jan 5, 2022

Conversation

trivikr
Copy link
Member

@trivikr trivikr commented Jan 5, 2022

Issue

Related to using root tsconfig for all clients in aws-sdk-js-v3
Refs: #1307

Description

Moves non-internal devDeps to root

Testing

Verified with client-acm that devDeps defined at root are used.

typescript
$ client-acm> rm -rf dist-*

$ client-acm> ./node_modules/.bin/tsc    
zsh: no such file or directory: ./node_modules/.bin/tsc

$ client-acm> yarn build
yarn run v1.22.17
$ yarn build:cjs && yarn build:es && yarn build:types
$ tsc -p tsconfig.json
$ tsc -p tsconfig.es.json
$ tsc -p tsconfig.types.json
Done in 18.78s.

$ client-acm> ls dist-*
dist-cjs:
ACMClient.js  commands      index.js  pagination  runtimeConfig.browser.js  runtimeConfig.native.js  waiters
ACM.js        endpoints.js  models    protocols   runtimeConfig.js          runtimeConfig.shared.js

dist-es:
ACMClient.js  commands      index.js  pagination  runtimeConfig.browser.js  runtimeConfig.native.js  waiters
ACM.js        endpoints.js  models    protocols   runtimeConfig.js          runtimeConfig.shared.js

dist-types:
ACMClient.d.ts  commands        index.d.ts  pagination  runtimeConfig.browser.d.ts  runtimeConfig.native.d.ts  waiters
ACM.d.ts        endpoints.d.ts  models      protocols   runtimeConfig.d.ts          runtimeConfig.shared.d.ts
typedoc
$ client-acm> ls docs                    
ls: cannot access docs: No such file or directory

$ client-acm> ./node_modules/.bin/typedoc
zsh: no such file or directory: ./node_modules/.bin/typedoc

$ client-acm> yarn build:docs
yarn run v1.22.17
$ typedoc
Loaded plugin @aws-sdk/service-client-documentation-generator

Using TypeScript 4.3.5 from /local/home/trivikr/workspace/backup/backup-aws-sdk-js-v3/node_modules/typescript/lib
Warning: You are running in an unsupported TypeScript version! TypeDoc supports 3.9.x || 4.0.x
Deprecated as of 10.7.0. highlight(lang, code, ...args) has been deprecated.
Deprecated as of 10.7.0. Please use highlight(code, options) instead.
https://github.com/highlightjs/highlight.js/issues/2277
Rendering [========================================] 100%

Documentation generated at /local/home/trivikr/workspace/backup/backup-aws-sdk-js-v3/clients/client-acm/docs

Done in 8.35s.

$ client-acm> ls docs
assets  classes  enums  globals.html  index.html  interfaces  modules
downlevel-dts
$ client-acm> ./node_modules/.bin/downlevel-dts
zsh: no such file or directory: ./node_modules/.bin/downlevel-dts

$ client-acm> ls dist-types/ts3.4   
ls: cannot access dist-types/ts3.4: No such file or directory

$ client-acm> yarn downlevel-dts
yarn run v1.22.17
$ downlevel-dts dist-types dist-types/ts3.4
Done in 1.66s.

$ client-acm> ls dist-types/ts3.4   
ACMClient.d.ts  index.d.ts  runtimeConfig.browser.d.ts  waiters
ACM.d.ts        models      runtimeConfig.d.ts
commands        pagination  runtimeConfig.native.d.ts
endpoints.d.ts  protocols   runtimeConfig.shared.d.ts
rimraf
$ client-acm> ./node_modules/.bin/rimraf
zsh: no such file or directory: ./node_modules/.bin/rimraf

$ client-acm> ls docs
assets  classes  enums  globals.html  index.html  interfaces  modules

$ client-acm> yarn clean:docs
yarn run v1.22.17
$ rimraf ./docs
Done in 0.11s.

$ client-acm> ls docs
ls: cannot access docs: No such file or directory

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@trivikr trivikr requested a review from a team as a code owner January 5, 2022 16:06
@trivikr
Copy link
Member Author

trivikr commented Jan 5, 2022

Moving to draft till release automation moves to using build:docs
Currently it calls ./node_modules/.bin/typedoc in each client.

@trivikr trivikr marked this pull request as draft January 5, 2022 16:09
@codecov-commenter
Copy link

codecov-commenter commented Jan 5, 2022

Codecov Report

Merging #3139 (187431c) into main (f6a3ef5) will not change coverage.
The diff coverage is n/a.

❗ Current head 187431c differs from pull request most recent head 5de9993. Consider uploading reports for the commit 5de9993 to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##             main    #3139   +/-   ##
=======================================
  Coverage   75.19%   75.19%           
=======================================
  Files         474      474           
  Lines       20721    20721           
  Branches     4755     4755           
=======================================
  Hits        15581    15581           
  Misses       5140     5140           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f6a3ef5...5de9993. Read the comment docs.

@trivikr trivikr changed the title chore(deps-dev): use typedoc version defined in root chore(deps-dev): move non-internal devDeps to root Jan 5, 2022
@trivikr
Copy link
Member Author

trivikr commented Jan 5, 2022

Experienced multiple failures on trying to move @types/node dependency to root.
Created a separate feature request at #3142

@trivikr trivikr marked this pull request as ready for review January 5, 2022 19:57
@trivikr trivikr merged commit f7fd1f3 into aws:main Jan 5, 2022
@trivikr trivikr deleted the root-typedoc-dependency branch January 5, 2022 23:35
@github-actions
Copy link

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 20, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants