feat: support copy tasks in docs* outputTargets

オープン
#4,038 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
typescript

調査の方向性

まず copy-tasks のドキュメントを読み、stencil build --docs-readme で使用される docs-readme 出力ターゲットを追跡します。その動作を、issue で説明されている別の copy ターゲットと比較します。ドキュメントターゲットが示された copy 設定を受け入れ、一致するアセットを生成された docs ディレクトリにコピーできれば完了です。

索引モデルが issue の本文から書いたものです。

説明

Feature: Want this? Upvote it! Resolution: Refine
Prerequisites
Describe the Feature Request

implement what is described in https://stenciljs.com/docs/copy-tasks :

Each output target can have its own copy config, which is an array of objects that defines any files or folders that should be copied over to the output target's build directory.

also for documentation targets.

Describe the Use Case

copy images and other assets from src into generated docs directory

Describe Preferred Solution
  {
    type: 'docs-readme',
    dir: 'docs',
    copy: [
      {
        src: '**/doc/*.png',
        dest: 'images',
      },
    ],
},
Describe Alternatives

tried to use an additional 'copy' target :

  {
    type: 'docs-readme',
    dir: 'docs',
  },
  {
    type: 'copy',
    dir: 'docs',
    copy: [
      {
        src: '**/doc/*.png',
        dest: 'images',
      },
    ],
  },

but the copy task si not executed when launching stencil build --docs-readme (why?)

Related Code

No response

Additional Information

No response

主要言語
TypeScript
スター
13.2k
フォーク
865
平均マージ
2日 16時間
マージ済み PR(30日)
29

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

stenciljs/core のほかの issue

stenciljs/core の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。