facebookarchive/prepack

Include .flow files in the distributable package

Open

#545 opened on May 4, 2017

View on GitHub
 (0 comments) (1 reaction) (0 assignees)JavaScript (14,268 stars) (520 forks)batch import
enhancementhelp wanted

Description

I'd like to able to import the Options type, e.g.

import type {
  Options
} from 'prepack/lib/options.js.flow'

This is to enable type-hinting in https://github.com/gajus/prepack-webpack-plugin.

The current build strips types, or at least I don't see a way to import them.

The way I distribute my packages is using flow-copy-source, e.g. https://github.com/gajus/prepack-webpack-plugin/commit/69c3464816c1a524880473dd7999dda7f9915413

Contributor guide

Tech stack
javascript
Domain
build system
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScriptnpm package structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Investigate the current build process in prepack's package.json. Add a build step to copy .flow files from the source directory to the dist directory, using a tool like flow copy source or a simple shell script. Ensure that the main entry point in package.json points to the correct type definition file.
Include .flow files in the distributable package · facebookarchive/prepack#545 | Good First Issue