Skip to content

Files moved to types-2.0#12338

Closed
MindfusionSoftware wants to merge 2 commits into
DefinitelyTyped:types-2.0from
MindfusionSoftware:types-2.0
Closed

Files moved to types-2.0#12338
MindfusionSoftware wants to merge 2 commits into
DefinitelyTyped:types-2.0from
MindfusionSoftware:types-2.0

Conversation

@MindfusionSoftware
Copy link
Copy Markdown

@MindfusionSoftware MindfusionSoftware commented Oct 29, 2016

Please fill in this template.

  • Prefer to make your PR against the types-2.0 branch.
  • The package does not provide its own types, and you can not add them.
  • Test the change in your own code.
  • Follow the advice from the readme.
  • Avoid common mistakes.

If adding a new definition:

  • If this is for an NPM package, match the name. If not, do not conflict with the name of an NPM package.
  • Run tsc without errors.
  • Include the required files and header.

If changing an existing definition:

  • Provide a URL to documentation or source code which provides context for the suggested changes: <>
  • Increase the version number in the header if appropriate.

@dt-bot
Copy link
Copy Markdown
Member

dt-bot commented Oct 29, 2016

jsdiag/jsdiag.d.ts

Checklist

@MindfusionSoftware
Copy link
Copy Markdown
Author

MindfusionSoftware commented Oct 29, 2016

Checklist:
jsdiag/jsdiag.d.ts - what's the problem with the naming convention? It has passed the Travis CI test before: #12288

We got an email-request to move the PR to the types-2.0 branch which we did. The compile errors listed below do not seem to have anything to do with our files.

@MindfusionSoftware MindfusionSoftware changed the title Approved files moved to types-2.0 Files moved to types-2.0 Oct 29, 2016
@ghost
Copy link
Copy Markdown

ghost commented Oct 29, 2016

Failing tests here are OK, they are fixed by #12344.

@ghost
Copy link
Copy Markdown

ghost commented Oct 29, 2016

types-2.0 packages use a different structure than master.
Also, it looks like the package comes bundled with its own types.

The naming convention error is just there because there is no NPM package with that name.

@MindfusionSoftware
Copy link
Copy Markdown
Author

Thanks for your cooperation. We have changed the dir structure to comply with the types-2.0 rules. Here it is:

https://github.com/MindfusionSoftware/DefinitelyTyped/tree/types-2.0/jsdiag

Should we close this PR and open a new one for that?

@ghost
Copy link
Copy Markdown

ghost commented Nov 1, 2016

You could, but I still wonder why you need to make a PR to DefinitelyTyped if the types are already bundled into the package.

@MindfusionSoftware
Copy link
Copy Markdown
Author

Could you clarify what "bundled into the package" means?

We are sending you a PR because our users asked us to add the mindfusion definitions at the official @types repository. They want to use the angular-cli tool which pulls definitions from DefinitelyTyped.

@ghost
Copy link
Copy Markdown

ghost commented Nov 2, 2016

For NPM packages at least, we would absolutely want typings to be bundled -- users only need to call npm install once, typings are guaranteed to be up-to-date, and package authors don't need to wait for their PR to be accepted to DefinitelyTyped.

When I go to http://www.mindfusion.eu/javascript-diagram.html and download the trial, I get a ZIP archive containing jsdiag.d.ts. I don't know how exactly people will be installing jsdiag into their projects, but possibly the same process that installs .js files could install jsdiag.d.ts as well.

If you think that would be too difficult, we could accept a duplicate copy of it into DefinitelyTyped; but any time you wanted to update the types, you would need to make a PR here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants