Skip to content

WRR-14491: Update jsdoc-to-ts to support Limestone #46

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

WRR-14491: Update jsdoc-to-ts to support Limestone #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c6ce576
WRR-14491: Update jsdoc-to-ts to support Limestone
hong6316 Jan 20, 2025
8fb1eeb
update CHANGELOG.md
hong6316 Jan 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .travis.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ install:
- npm install
- npm link
- popd
- git clone --branch=develop --depth 1 https://github.com/enactjs/sandstone ../sandstone
- git clone --branch=develop --depth 1 https://github.com/enactjs/limestone ../limestone
- npm install
script:
- echo -e "\x1b\x5b35;1m*** Starting tests...\x1b\x5b0m"
Expand All @@ -24,5 +24,5 @@ script:
- node bin/jsdoc-to-ts -h
- echo -e "\x1b\x5b35;1m*** help option complete\x1b\x5b0m"
- echo -e "\x1b\x5b35;1m*** Starting JSDoc converting...\x1b\x5b0m"
- node bin/jsdoc-to-ts ../sandstone -o=../sandstone
- node bin/jsdoc-to-ts ../limestone -o=../limestone
- echo -e "\x1b\x5b35;1m*** JSDoc converting complete\x1b\x5b0m"
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Change Log

## [unreleased]

* Updated jsdoc-to-ts CLI option to support Limestone.

## [1.0.7] (January 15, 2025)

* Updated `react` dependency to `^19.0.0`.
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ You also have to configure the app to resolve the generated typings by adding th
Assuming jsdoc-to-ts is installed and linked globally on the current device, and we want to run the command in one of the installed Enact packages (core, ui, i18n, etc.) folder:

```bash
jsdoc-to-ts --ignore='["node_modules", "ilib", "build", "docs", "tests", "samples"]' --importMap='{"core":"@enact/core","ui":"@enact/ui","spotlight":"@enact/spotlight","i18n":"@enact/i18n","webos":"@enact/webos","moonstone":"@enact/moonstone","agate":"@enact/agate","sandstone":"@enact/sandstone"}' --outputPath='.'
jsdoc-to-ts --ignore='["node_modules", "ilib", "build", "docs", "tests", "samples"]' --importMap='{"core":"@enact/core","ui":"@enact/ui","spotlight":"@enact/spotlight","i18n":"@enact/i18n","webos":"@enact/webos","moonstone":"@enact/moonstone","agate":"@enact/agate","sandstone":"@enact/sandstone","limestone":"@enact/limestone"}' --outputPath='.'
Copy link
Contributor Author

@hong6316 hong6316 Jan 20, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should moonstone needs to be kept in here?

```

## Assumptions
Expand Down
3 changes: 2 additions & 1 deletion bin/jsdoc-to-ts.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ const opts = minimist(process.argv.slice(2), {
moonstone: '@enact/moonstone',
Copy link
Contributor Author

@hong6316 hong6316 Jan 20, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should moonstone and moonstone-ez need to be kept in here?

'moonstone-ez': '@enact/moonstone-ez',
agate: '@enact/agate',
sandstone: '@enact/sandstone'
sandstone: '@enact/sandstone',
limestone: '@enact/limestone'
},
outputPath: '.'
},
Expand Down