Use files in package.json

[SimenB]

This avoids installing tests and dotfiles when installing your package

[mafintosh]

couldn't this just be *.js (like tar-stream does, https://github.com/mafintosh/tar-stream/blob/master/package.json#L47-L50) to make it easier to maintain?

[SimenB]

I think being explicit is easier to maintain. If you add a new file that is needed by consumers, you add it to the array. If it's just a JS-file (maybe you decide to use Grunt/Gulp, for instance), then it's not automatically included.

As of now, this does not include example.js, which is a good example, IMO 😄

[mafintosh]

we tried doing that in tar-stream and i kept forgetting to add files to pkg json. tests would still work locally so was hard to catch.

[SimenB]

What about moving the js files needed by the package (except for index.js) into a lib directory?

[mafintosh]

can you whitelist the entire lib folder then? :)

[SimenB]

Yup

On Fri, 17 Apr 2015 07:59 Mathias Buus [email protected] wrote:

can you whitelist the entire lib folder then? :)

—
Reply to this email directly or view it on GitHub
#57 (comment)
.

[mafintosh]

i'd be fine with that 👍

[SimenB]

@mafintosh Done 😄

[TrySound]

@mafintosh Make new release please.

[SimenB]

@mafintosh ping

[lucleray]

@LinusU I'd love to see this PR merged.

[LinusU]

Hey, sorry for the late turnaround on this. I'm definitely 👍 on this.

I don't think that we should move around the files without a major break though. I've seen require('is-my-json-valid/formats') out in the wild, same with /require.

That being said, I don't think that we'll add any new files in the foreseeable future, so I would be okay with listing index.js, formats.js, require.js and files/ in the list, what do you think about that?

Thanks!

edit: oh, and also index.d.ts 🤔

hmm, I wonder if anyone is using /require, maybe it's time to drop that feature 🤔

and if we also want to have, /formats as an entrypoint, we should add a formats.d.ts file as well...

[SimenB]

I haven't used this module in years, feel free to tweak this PR or just start from scratch. It seems I've even deleted my fork at some point 😅

[LinusU]

Sounds good, thanks for the PR and initiative!