OfficeDev / OfficeDev/Office-Addin-Scripts

custom-functions-metadata-plugin: type annotation is wrong

Open Beginner friendly
#938 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
194
Forks
117
Avg merge
1d 32m
Merged PRs (30d)
2

Description

custom-functions-metadata-plugin allows multiple files to be input.

https://github.com/OfficeDev/Office-Addin-Scripts/tree/master/packages/custom-functions-metadata-plugin#webpack-example-webpackconfigjs

new CustomFunctionsMetadataPlugin({
  input: [
            "./src/functions/someFunctions.js", 
            "./src/functions/otherFunctions.js"
          ], 
  output: "functions.json"
}),

The type of input in Options is string, but it should be string | string[].

https://github.com/OfficeDev/Office-Addin-Scripts/blob/6b973f8848dcd644c886378981e900b8425b80ac/packages/custom-functions-metadata-plugin/src/customfunctionsplugin.ts#L12

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in packages/custom-functions-metadata-plugin/src/customfunctionsplugin.ts at the Options definition referenced by the issue. Compare that declaration with the documented webpack example using multiple input files, then verify that the type accepts both the single-file and array forms.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript, webpack
Domain
build-system, tooling
Issue type
Bug
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.