{"_id":"@duanlangtaosha/xbb-helper","name":"@duanlangtaosha/xbb-helper","dist-tags":{"latest":"2.0.9"},"versions":{"2.0.9":{"name":"@duanlangtaosha/xbb-helper","version":"2.0.9","description":"A source xPack with scripts and other files to support XBB builds","main":"","scripts":{"postversion":"git push origin --all && git push origin --tags","test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git+https://github.com/duanlangtaosha/xbb-helper-xpack.git"},"homepage":"https://github.com/xpack-dev-tools/xbb-helper-xpack/","bugs":{"url":"https://github.com/xpack-dev-tools/xbb-helper-xpack/issues/"},"keywords":["xpack"],"author":{"name":"Liviu Ionescu","email":"ilg@livius.net","url":"https://github.com/ilg-ul/"},"license":"MIT","config":{},"dependencies":{},"devDependencies":{},"xpack":{"minimumXpmRequired":"0.16.3","dependencies":{},"devDependencies":{},"properties":{},"actions":{"npm-install":"npm install","npm-pack":"npm pack","npm-version-patch":"npm version patch","npm-version-minor":"npm version minor","git-log":"git log --pretty='%cd * %h %s' --date=short"},"buildConfigurations":{}},"gitHead":"ee94ae092de014a4bb599a8de0c782ebd5c2ae46","_id":"@duanlangtaosha/xbb-helper@2.0.9","_nodeVersion":"12.22.9","_npmVersion":"8.5.1","dist":{"integrity":"sha512-D29vb+aUhCa+G6ClGpS3xIuNR7XzG1inGbUwRRq30tGyqT1V3mPIlOiSnBhdpFNnX6dPx45qW8QaukiL848AIA==","shasum":"9471283ef43dd35fa7924a1ebe39832edc5de284","tarball":"https://registry.npmjs.org/@duanlangtaosha/xbb-helper/-/xbb-helper-2.0.9.tgz","fileCount":252,"unpackedSize":1680112,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCz6hAxa8ps339c5m4pL+iG+FPMpKVVdMfPFAjBHcYFfgIhAJTZU8BhDJaAfFyOR1XfQ9YqB83ZjUBqvYrDof4MlXl4"}]},"_npmUser":{"name":"duanlangtaoshao","email":"891650837@qq.com"},"directories":{},"maintainers":[{"name":"duanlangtaoshao","email":"891650837@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/xbb-helper_2.0.9_1714894229809_0.99633157308194"},"_hasShrinkwrap":false}},"time":{"created":"2024-05-05T07:30:29.739Z","2.0.9":"2024-05-05T07:30:30.039Z","modified":"2024-05-05T07:30:30.309Z"},"maintainers":[{"name":"duanlangtaoshao","email":"891650837@qq.com"}],"description":"A source xPack with scripts and other files to support XBB builds","homepage":"https://github.com/xpack-dev-tools/xbb-helper-xpack/","keywords":["xpack"],"repository":{"type":"git","url":"git+https://github.com/duanlangtaosha/xbb-helper-xpack.git"},"author":{"name":"Liviu Ionescu","email":"ilg@livius.net","url":"https://github.com/ilg-ul/"},"bugs":{"url":"https://github.com/xpack-dev-tools/xbb-helper-xpack/issues/"},"license":"MIT","readme":"[![GitHub package.json version](https://img.shields.io/github/package-json/v/xpack-dev-tools/xbb-helper-xpack)](https://github.com/xpack-dev-tools/xbb-helper-xpack/blob/xpack/package.json)\n[![npm (scoped)](https://img.shields.io/npm/v/@xpack-dev-tools/xbb-helper.svg?color=blue)](https://www.npmjs.com/package/@xpack-dev-tools/xbb-helper/)\n[![license](https://img.shields.io/github/license/xpack-dev-tools/xbb-helper-xpack)](https://github.com/xpack-dev-tools/xbb-helper-xpack/blob/xpack/LICENSE)\n\n# A source xPack with helper files for the XBB builds\n\nThis project provides common scripts and other files useful during\n**xPack Build Box (XBB)** builds.\n\nThis open source project is hosted on GitHub as\n[`xpack-dev-tools/xbb-helper-xpack`](https://github.com/xpack-dev-tools/xbb-helper-xpack).\n\n## Overview\n\nThis projects includes:\n\n- shell scripts to build various projects as dependencies\n(see the `dependencies` folder)\n- templates used to generate project configurations\n- tests\n- patches\n- other files\n\n## Maintainer info\n\nThis page is addressed to developers who plan to include this package\ninto their own projects.\n\nFor maintainer info, please see:\n\n- [How to publish](https://github.com/xpack-dev-tools/xbb-helper-xpack/blob/xpack/README-MAINTAINER.md).\n\n## Install\n\nAs a source xPack, the easiest way to add it to a project is via\n**xpm**, but it can also be used as any Git project, for example as a submodule.\n\n### Prerequisites\n\nA recent [xpm](https://xpack.github.io/xpm/),\nwhich is a portable [Node.js](https://nodejs.org/) command line application\nthat complements [npm](https://docs.npmjs.com)\nwith several extra features specific to\n**C/C++ projects**.\n\nIt is recommended to install/update to the latest version with:\n\n```sh\nnpm install --location=global xpm@latest\n```\n\nFor details please follow the instructions in the\n[xPack install](https://xpack.github.io/install/) page.\n\n### xpm\n\nThis package is available as\n[`@xpack-dev-tools/xbb-helper`](https://www.npmjs.com/package/@xpack-dev-tools/xbb-helper)\nfrom the `npmjs.com` registry:\n\n```sh\ncd my-project\nxpm init # Unless a package.json is already present\n\nxpm install --save-dev @xpack-dev-tools/xbb-helper@latest --verbose\n\nls -l xpacks/@xpack-dev-tools/xbb-helper\n```\n\n### Git submodule\n\nIf, for any reason, **xpm** is not available, the next recommended\nsolution is to link it as a Git submodule below an `xpacks` folder.\n\n```sh\ncd my-project\ngit init # Unless already a Git project\nmkdir -p xpacks\n\ngit submodule add https://github.com/xpack-dev-tools/xbb-helper-xpack.git \\\n  xpacks/@xpack-dev-tools/xbb-helper\n```\n\n## Branches\n\nApart from the unused `master` branch, there are two active branches:\n\n- `xpack`, with the latest stable version (default)\n- `xpack-develop`, with the current development version\n\nAll development is done in the `xpack-develop` branch, and contributions via\nPull Requests should be directed to this branch.\n\nWhen new releases are published, the `xpack-develop` branch is merged\ninto `xpack`.\n\n## Developer info\n\nThis project includes several bash scripts with functions that can be\nused for common jobs in application builds.\n\n### Integration info\n\nA typical use case is to define an xPack action that copies, among\nother things, the build scripts from the helper templates:\n\n```json\n  \"cp xpacks/@xpack-dev-tools/xbb-helper/templates/build.sh scripts/\",\n  \"cp xpacks/@xpack-dev-tools/xbb-helper/templates/test.sh scripts/\"\n```\n\nThe resulting `scripts/build.sh` requires two application scripts:\n\n- `scripts/application.sh` - with common definitions\n- `scripts.versioning.sh` - with details how to build different versions\n\nThe resulting `scripts/test.sh` requires:\n\n- `scripts/application.sh` - with common definitions\n- `tests/run.sh` - the code to run the validation tests\n- `tests/update.sh` - optional updates for different docker environments\n\n### Known problems\n\n- none\n\n### Tests\n\nThere are currently no CI tests specific for this package.\n\nThe files in the `tests` folder are used during native compilers tests.\n\n### Examples\n\nPlease see any of the existing projects, like:\n\n- <https://github.com/xpack-dev-tools/gcc-xpack/>\n\n## Change log - incompatible changes\n\nAccording to [semver](https://semver.org) rules:\n\n> Major version X (X.y.z | X > 0) MUST be incremented if any\nbackwards incompatible changes are introduced to the public API.\n\nThe incompatible changes, in reverse chronological order,\nare:\n\n- v0.x: pre-release versions\n\n## Support\n\nFor support, please use GitHub\n[Discussions](https://github.com/xpack-dev-tools/xbb-helper-xpack/discussions/).\n\n## License\n\nThe original content is released under the\n[MIT License](https://opensource.org/licenses/MIT/),\nwith all rights reserved to\n[Liviu Ionescu](https://github.com/ilg-ul/).\n","readmeFilename":"README.md"}