OpenINF/openinf-util-types

[feature request] prevent including unnecessary files in the deployed package

Open

#39 opened on Aug 1, 2022

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)TypeScript (2 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (3 stars)
PR merge metrics
 (PR metrics pending)

Description

We should consider adding the "files" stanza to the package.json to create an explicit allowlist and prevent deploying any unnecessary files to the npm registry as part of our package. This would be preferable to using a .npmignore file, which we have been doing so far but is expected to quickly become unmanageable as more files are added.

Contributor guide

Research direction
Open the package.json file in the repository root and add a 'files' field listing the files/directories to include in the published package. Remove the .npmignore file if it exists. The 'files' field supports glob patterns. Typically include the built output directory (e.g., dist) and exclude source files and tests.
Tech stack
typescript
Domain
release
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
npmpackage.json
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90