GitShow/sindresorhus/vinyl-file
sindresorhus

vinyl-file

Create a Vinyl file from an actual file

by sindresorhus
Star on GitHubForknpm

JavaScript

43 stars4 forks6 contributorsQuiet · 3y agoSince 2014v5.0.0MIT

Meet the team

See all 6 on GitHub →
sindresorhus
sindresorhus28 contributions
SamVerschueren
SamVerschueren2 contributions
floatdrop
floatdrop2 contributions
pioug
pioug1 contribution
Silic0nS0ldier
Silic0nS0ldier1 contribution
Richienb
Richienb1 contribution

Languages

View on GitHub →
JavaScript62.6%
TypeScript37.4%

Commit activity

Last 12 weeks · 0 commits

Full graph →

Community health

4 of 6 standards met

Community profile →
85
✓README✓License✓Contributing✓Code of Conduct○Issue Template○PR Template

Recent fixes

View closed PRs →
pioug
Update vinyl@3.0.0MergedPR

As per https://github.com/gulpjs/vinyl/releases/tag/v3.0.0, it requires bumping a major version ⚠️

pioug · 3y ago
Silic0nS0ldier
Add TypeScript definitionMergedPR

Adds TypeScript type definitions for the package. Existing types on DefinitelyTyped (for v3) return generic Vinyl instances. https://github.com/DefinitelyTyped/DefinitelyTyped/blob/8feddddbbb2915816ac5787f50b65d267e9e40cf/types/vinyl-file/index.d.ts#L78-L79 This is inconsistent with upstream types, which narrow based on provided options. https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/vinyl/index.d.ts#L55-L60 Since narrowing is more correct (and can eliminate redundant checks) I've applied it here. There is however a problem with the current implementation, it relies on . The following cases fail without the flag enabled. doesn't report this as a problem, presumably due to it operating under strict mode. TODO [x] ~Fix incorrect return type when ~ This is also a problem DefinitelyTyped has to deal with and is enabled by default over there (see https://github.com/DefinitelyTyped/DefinitelyTyped#tsconfigjson). I'm happy to consider this not working without as an unsupported scenario, if this is a dealbreaker happy to change back to a merge generic return type. Resolves #9

Silic0nS0ldier · 4y ago
Silic0nS0ldier
Include TS typesClosedIssue

Currently types for this package can be sourced from DefinitelyTyped, however they are out of date. I'm happy to get them updated (matching semantics of other sindresorhus ESM packages which include types, e.g. https://github.com/sindresorhus/debounce-fn). If however maintainers are open to including types in the package, I'm happy to put a PR together. Module declaration types for v4

Silic0nS0ldier · 4y ago
Structured data for AI agents

Repository: sindresorhus/vinyl-file. Description: Create a Vinyl file from an actual file Stars: 43, Forks: 4. Primary language: JavaScript. Languages: JavaScript (62.6%), TypeScript (37.4%). License: MIT. Latest release: v5.0.0 (3y ago). Open PRs: 0, open issues: 0. Last activity: 3y ago. Community health: 85%. Top contributors: sindresorhus, SamVerschueren, floatdrop, pioug, Silic0nS0ldier, Richienb.

·@ofershap

Replace github.com with gitshow.dev