Docs on publishing of header-only C++ libs (include in node c++ modules)

オープン

#20 2017年1月10日に作成コメント 3 件リアクション 0 件担当者 0 名 GitHub で見る

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

評価

難易度: 4/5
見積もり時間: 3〜5日
初心者へのやさしさ: 35/100

issue の種類: 機能追加
明瞭さ: おおむね明確
活発さ: 停滞
技術スタック: cpp, nodejs
領域: release, tooling

調査の方向性

このリポジトリ内のheader-only C++ライブラリを特定し、Nanのpackage.jsonとinclude_dirs.jsのパターンをリンクされた例と比較します。各ライブラリに要求されたパッケージメタデータを追加し、その後 npm pack を実行してtarballを調査し、ヘッダーとnpmのデフォルトファイルのみが含まれていることを確認します。

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

説明

rational

We are increasingly working on small node C++ modules that depend on header-only C++ libs.
Node.js's Nan module has pioneered a best practice for how to include header only C++ libs in node C++ addons by simply adding a package.json and include_dirs.js file to the root of the project. I think we should follow the lead of howNan does this and package all our C++ header only libs in npm as well as mason. I think publishing in two places is worth it because it makes including the libraries from node modules very easy and consistent with how JS modules work.

method

Add:

package.json
include_dirs.js
files parameter to package.json so that only the include/ directory is included

Example:

{
    "name": "@mapbox/geometry-hpp",
    "version": "0.9.0",
    "description": "A C++ header only geometry type library",
    "main": "./include_dirs.js",
    "repository"   :  {
      "type" : "git",
      "url"  : "git://github.com/mapbox/geometry.hpp.git"
    },
    "files": [
         "include"
    ]
}

Then test that only the right files are going to be packaged:

npm pack
tar -ztvf *tgz

^^ that should list just the headers and the default files npm includes like README.md and package.json etc

Examples:

Example use case:

https://github.com/springmeyer/node-osmium-count/blob/master/package.json#L17

主要言語: 言語のデータがありません
スター: 110
フォーク: 17
PR マージ指標: 30日以内にマージされた PR はありません

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

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

mapbox/cpp のほかの issue

[glossary] add details about why forward declarations are useful オープン

glossary

難易度 1/5 1時間未満初心者へのやさしさ 68/100

mapbox/cpp#53 · 2018年3月30日に作成
Changes needed as mapbox-gl-native is public archive オープン

難易度 3/5 1〜2日初心者へのやさしさ 25/100

mapbox/cpp#59 · 2023年8月24日に作成
Docs on ABIs オープン

難易度 4/5 3〜5日初心者へのやさしさ 30/100

mapbox/cpp#55 · コメント 2 件 · 2018年4月30日に作成
clang-tidy v. -Weffc++ オープン

難易度 5/5 1週間以上初心者へのやさしさ 30/100

mapbox/cpp#54 · コメント 1 件 · 2018年4月24日に作成
docs/learning-resources.md blank オープン

難易度 3/5 1〜2日初心者へのやさしさ 35/100

mapbox/cpp#52 · コメント 5 件 · 2018年3月13日に作成

mapbox/cpp の issue をすべて見る

似ている issue

[Package Request]: Quiver Launcher オープン

Help-Wanted Needs-Triage Package-Request

難易度 2/5 1〜3時間初心者へのやさしさ 68/100

microsoft/winget-pkgs#438680 · 2026年9月21日に作成
Update ghgrab to 2.1.0 オープン

package-update

難易度 2/5 1〜3時間初心者へのやさしさ 76/100

oSoWoSo/vOid_Community_repOsitory#148 · コメント 1 件 · 2026年9月21日に作成
Update changelog for 2.1.25 (release is ongoing ...) オープン

難易度 1/5 1時間未満初心者へのやさしさ 70/100

coursier/coursier#3868 · 2026年9月21日に作成
Remove soundfonts from install directory in NSIS script オープン

OS:Windows

難易度 2/5 1〜3時間初心者へのやさしさ 82/100

CorsixTH/CorsixTH#3555 · 2026年9月21日に作成
After the next release ships: tell the #370 reporter how to turn on separate container lists オープン

難易度 1/5 1時間未満初心者へのやさしさ 68/100

j127/auto_delete_cookies_for_privacy#413 · 2026年9月21日に作成

Release の issue をもっと見る