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

Offen

#20 erstellt am 10.1.2017 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 4/5
Geschätzter Aufwand: 3-5 Tage
Anfängerfreundlichkeit: 35/100

Issue-Typ: Feature
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: cpp, nodejs
Bereich: release, tooling

Rechercherichtung

Finde die header-only-C++-Bibliotheken in diesem Repository und vergleiche das Muster von Nan's package.json und include_dirs.js mit den verlinkten Beispielen. Füge für jede Bibliothek die angeforderten Paketmetadaten hinzu, führe dann npm pack aus und überprüfe das Tarball, um zu bestätigen, dass es nur die Header und die Standarddateien von npm enthält.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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

Vorherrschende Sprache: Keine Sprachdaten
Sterne: 110
Forks: 17
PR-Merge-Kennzahlen: Keine gemergten PRs in 30 T.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus mapbox/cpp

[glossary] add details about why forward declarations are useful Offen

glossary

Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 68/100

mapbox/cpp#53 · Erstellt am 30.3.2018
Changes needed as mapbox-gl-native is public archive Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 25/100

mapbox/cpp#59 · Erstellt am 24.8.2023
Docs on ABIs Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 30/100

mapbox/cpp#55 · 2 Kommentare · Erstellt am 30.4.2018
clang-tidy v. -Weffc++ Offen

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 30/100

mapbox/cpp#54 · 1 Kommentar · Erstellt am 24.4.2018
docs/learning-resources.md blank Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 35/100

mapbox/cpp#52 · 5 Kommentare · Erstellt am 13.3.2018

Alle Issues in mapbox/cpp