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

Questions about @jxa/sdef-to-dts #38

Open
JMichaelTX opened this issue Jun 6, 2021 · 1 comment
Open

Questions about @jxa/sdef-to-dts #38

JMichaelTX opened this issue Jun 6, 2021 · 1 comment
Labels
Type: Question Further information is requested

Comments

@JMichaelTX
Copy link

First, let me give you many, many thanks for providing this tool.
I hope to use it to provide autocomplete in Visual Studio Code (VSC) for many of the third party apps (like Microsoft Outlook, Evernote, and Keyboard Maestro, and more) and many of the AppleScript Scripting Libraries (like Shane Stanley's "Myriad Tables Lib").

I have several questions:

Installation

My first question is about installation, using this command you provided:
npm install @jxa/sdef-to-dts

Where do I install this? What folder do I need to be in so that it is available to all folders and workspaces of VSC?

Using @jxa/sdef-to-dts

You provide this command to convert .sdef and .app files
$ npx @jxa/sdef-to-dts /Applications/Safari.app --output ./safari.d.ts

Two Questions:

  1. Where do I run this command so that the resulting dts files are fully integrated with other dts files, and so that all of these are available to all folders and workspaces of VSC?
  2. Does the name of the output dts file need to exactly match the input name?
    • For example, if the input file is "Microsoft Outlook.app", does the output file need to be "Microsoft Outlook.d.ts"?

Many thanks.

@azu azu added the Type: Question Further information is requested label Jun 8, 2021
@azu
Copy link
Member

azu commented Jul 12, 2021

@jxa/sdef-to-dts is just converter that generate from sdef to d.ts file.

Where do I run this command so that the resulting dts files are fully integrated with other dts files, and so that all of these are available to all folders and workspaces of VSC?

It may related to https://www.typescriptlang.org/tsconfig#types

Does the name of the output dts file need to exactly match the input name?

Probably, No.

https://www.typescriptlang.org/docs/handbook/declaration-files/templates/module-d-ts.html
However, TypeSript's namespace disallow to include space.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants