search

felixSchl / photoshop.d.ts

Typescript declaration files and generator for the Photoshop javascript API
Other
78 stars 9 forks source link

Remove lib.d.ts, update README.md, add CHANGELOG.md and LICENSE #16

Closed perludum closed 6 years ago

perludum commented 6 years ago

As of TypeScript 2.0 the standard library declarations (ES5 to ES2017) are built in, so I'd propose removing the lib.d.ts from the project - also in order to allow other standard libs (like ES3).

I updated the README.md and added some notes about ECMAScript 3 and how to deal with a suitable polyfill for ECMAScript 5.

Also moved the version notes to a CHANGELOG.md and added a LICENSE file.

felixSchl commented 6 years ago

You should add your name to the Copyright file as well. Full disclosure: I have not much of a clue about licensing, but it seems if you do this much work you should have your name in there

perludum commented 6 years ago

Thank you for your review! There's also a problem with travis and I will investigate it shortly.

perludum commented 6 years ago

OK I got it with travis: The declarations files in this project need to be tested with slightly different conditions (in particular just with the ES5 standard lib) than the app.ts. I fixed this in the package.json. So there will be free choice of the standard lib now :) I tested the declarations again in a TS/ES project with the new setup and I think it's ready to merge now.

Thank you for your notes, they are merged in with the latest readme.md commit!

felixSchl commented 6 years ago

Sweet, it looks like this package is coming together quite nicely, do you think it's time for 1.x.x with these updates or do you have further changes in the back of your mind that will happen soon? Would you be able to update changelog.md with these changes, either assuming 0.5.0 or 1.0.0

perludum commented 6 years ago

Absolutely, I think this package is ready for a 1.0 release!

Currently I’ve no further changes in my mind, because everything seems to work fine so far. I didn’t test each and every declaration, but in the next weeks, I’ll use this lib actively in an ExtendScript project and see if there are any issues left and would try to fix them, if at all.

As a last-minute update, the comment format in the ExtendScript declarations now have a line length of 80 characters, too, and it even looks nicer.

Finally, the changelog is updated for a major version release :)