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.

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

README should include Unix-separator hint #1

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

README should include Unix-separator hint #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,9 @@ $ clutz path/to/my/source1.js path/to/my/source2.js ...
-o out.d.ts
```

This creates TypeScript type definitions in `out.d.ts` for all the closure types discovered in the inputs.
When **running on Windows**, note that you have to use **Unix-style path separators** for the file paths (`/` instead of `\`).

The example above creates TypeScript type definitions in `out.d.ts` for all the closure types discovered in the inputs.
Symbols which were declared with `goog.provide('x')` may be imported in TypeScript as `import x from 'goog:x';`.
For full explanation of what TypeScript types are produced for different Closure usages, see the `.js` and `.d.ts`
files in `src/test/com/google/javascript/clutz`.
Expand Down