@xpack/hello-world-template

    0.5.2 • Public • Published

    npm (scoped) GitHub tag (latest by date) license CI on Push

    A source xPack with a template to generate Hello World projects

    Generate simple Hello World projects to demonstrate the xPack Build framework.

    The project is hosted on GitHub as xpack/hello-world-template-xpack, and is also available from npmjs.com as @xpack/hello-world-template.

    Features

    This project generates multiple variants of the classical application that prints the Hello World message on standard output.

    Both C and C++ are supported, with CMake and meson as build system generators; it is also possible to create projects that use the legacy autotools & make, but only as a configuration demonstrator, for real projects the configuration needs further tweaks.

    The hello-world-template project is part of The xPack Project.

    It can be invoked in a terminal, but the main intended use was to be integrated into the VS Code xPack Build extension, to generate new projects.

    Prerequisites

    A recent xpm, which is a portable Node.js command line application.

    npm install --global xpm@latest

    If installing over a previous version fails, uninstall first:

    npm uninstall --global xpm
    npm install --global xpm@latest

    User info

    Template instantiation via xpm init

    Instantiating the template can be done via the xpm init --template command, pointing to this xPack.

    This command must be invoked in an empty folder, where the project will be generated.

    There are two modes, interactive and non interactive (from a script).

    Interractive mode

    Starting the tool without any command line options will select the interactive mode and the user can manually enter each choice.

    Starting the tool without defining the programming language will select the interactive mode and the user can manually enter each choice.

    % mkdir my-project
    % cd my-project
    % xpm init --template @xpack/hello-world-template@latest
    
    Checking package @xpack/hello-world-template@latest metadata...
    Installing @xpack/hello-world-template@0.5.2...
    Processing @xpack/hello-world-template@0.5.2...
    
    Programming language? (c, cpp, ?) [cpp]:
    Build System? (cmake, meson, autotools, ?) [cmake]:
    Toolchain? (gcc, system, ?) [gcc]:
    Creating the C++ project 'my-project'...
    File 'include/hello-world.h' copied.
    File 'src/hello-world.cpp' copied.
    File 'libs/adder/include/add/add.h' copied.
    File 'libs/adder/src/add.c' copied.
    File 'meta/CMakeLists.txt' generated.
    File 'meta/toolchain-gcc.cmake' copied.
    File '.vscode/tasks.json' copied.
    File '.clang-format' copied.
    File 'README.md' generated.
    File 'LICENSE' generated.
    File 'package.json' generated.
    %

    Scriptable mode

    When used in non-interractive environments, it is possible to pass all required data on the command line. The only mandatory property is language, all other have defaults.

    % cd my-project
    % xpm init --template @xpack/hello-world-template@latest --property language=cpp
    
    Installing @xpack/hello-world-template@0.5.2...
    Processing @xpack/hello-world-template@0.5.2...
    
    Creating the C++ project 'my-project'...
    - buildGenerator=cmake
    - toolchain=gcc
    
    File 'include/hello-world.h' copied.
    File 'src/hello-world.cpp' copied.
    File 'libs/adder/include/add/add.h' copied.
    File 'libs/adder/src/add.c' copied.
    File 'meta/CMakeLists.txt' generated.
    File 'meta/toolchain-gcc.cmake' copied.
    File '.vscode/tasks.json' copied.
    File '.clang-format' copied.
    File 'README.md' generated.
    File 'LICENSE' generated.
    File 'package.json' generated.
    %

    Satisfy dependencies

    The next step is to install all packages required, either source packages or binary tools.

    This is done by issuing the xpm install command in the project folder:

    % cd my-project
    % xpm install
    @my-scope/my-project...
    + @xpack-dev-tools/cmake@3.19.8-1.1
    + @xpack-dev-tools/gcc@8.5.0-1.1
    + @xpack-dev-tools/ninja-build@1.10.2-3.1
    'xpacks/xpack-dev-tools-cmake' -> '/Users/ilg/Library/xPacks/@xpack-dev-tools/cmake/3.19.8-1.1'
    'xpacks/xpack-dev-tools-gcc' -> '/Users/ilg/Library/xPacks/@xpack-dev-tools/gcc/8.5.0-1.1'
    'xpacks/xpack-dev-tools-ninja-build' -> '/Users/ilg/Library/xPacks/@xpack-dev-tools/ninja-build/1.10.2-3.1'
    'xpacks/.bin/ccmake' -> '../xpack-dev-tools-cmake/.content/bin/ccmake'
    'xpacks/.bin/ninja' -> '../xpack-dev-tools-ninja-build/.content/bin/ninja'
    'xpacks/.bin/cmake' -> '../xpack-dev-tools-cmake/.content/bin/cmake'
    'xpacks/.bin/c++' -> '../xpack-dev-tools-gcc/.content/bin/c++'
    'xpacks/.bin/cpack' -> '../xpack-dev-tools-cmake/.content/bin/cpack'
    'xpacks/.bin/ctest' -> '../xpack-dev-tools-cmake/.content/bin/ctest'
    'xpacks/.bin/cpp' -> '../xpack-dev-tools-gcc/.content/bin/cpp'
    'xpacks/.bin/g++' -> '../xpack-dev-tools-gcc/.content/bin/g++'
    'xpacks/.bin/gcc' -> '../xpack-dev-tools-gcc/.content/bin/gcc'
    'xpacks/.bin/gcov' -> '../xpack-dev-tools-gcc/.content/bin/gcov'
    'xpacks/.bin/gcov-dump' -> '../xpack-dev-tools-gcc/.content/bin/gcov-dump'
    'xpacks/.bin/gcov-tool' -> '../xpack-dev-tools-gcc/.content/bin/gcov-tool'
    'xpacks/.bin/gfortran' -> '../xpack-dev-tools-gcc/.content/bin/gfortran'
    %

    Build and test

    The generated project includes dependencies to all build tools, except the toolchain, which must be available in a system location, such that the build system generator can find it.

    % cd my-project
    % xpm run test
    > xpm run prepare-all
    > xpm run prepare --config Debug
    > cmake -S meta -B build/debug -G Ninja -D CMAKE_BUILD_TYPE=Debug -D CMAKE_EXPORT_COMPILE_COMMANDS=ON -D CMAKE_TOOLCHAIN_FILE=toolchain-gcc.cmake
    -- CMake version: 3.19.8-g290a19d
    -- The C compiler identification is GNU 8.5.0
    -- Detecting C compiler ABI info
    -- Detecting C compiler ABI info - done
    -- Check for working C compiler: /Users/ilg/tmp/my-project/xpacks/.bin/gcc - skipped
    -- Detecting C compile features
    -- Detecting C compile features - done
    -- The CXX compiler identification is GNU 8.5.0
    -- Detecting CXX compiler ABI info
    -- Detecting CXX compiler ABI info - done
    -- Check for working CXX compiler: /Users/ilg/tmp/my-project/xpacks/.bin/g++ - skipped
    -- Detecting CXX compile features
    -- Detecting CXX compile features - done
    -- The ASM compiler identification is GNU
    -- Found assembler: /Users/ilg/tmp/my-project/xpacks/.bin/gcc
    -- Compiler: GNU 8.5.0
    -- Build type: Debug
    -- Project path: /Users/ilg/tmp/my-project
    -- PATH: /Users/ilg/tmp/my-project/xpacks/.bin:/Users/ilg/tmp/my-project/xpacks/.bin:/Users/ilg/tmp/my-project/xpacks/.bin:/Users/ilg/Library/Python/3.7/bin:/Library/Frameworks/Python.framework/Versions/3.7/bin:/Users/ilg/.nvm/versions/node/v14.16.0/bin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin
    -- ==> application
    -- Configuring done
    -- Generating done
    -- Build files have been written to: /Users/ilg/tmp/my-project/build/debug
    > xpm run prepare --config Release
    > cmake -S meta -B build/release -G Ninja -D CMAKE_BUILD_TYPE=Release -D CMAKE_EXPORT_COMPILE_COMMANDS=ON -D CMAKE_TOOLCHAIN_FILE=toolchain-gcc.cmake
    -- CMake version: 3.19.8-g290a19d
    -- The C compiler identification is GNU 8.5.0
    -- Detecting C compiler ABI info
    -- Detecting C compiler ABI info - done
    -- Check for working C compiler: /Users/ilg/tmp/my-project/xpacks/.bin/gcc - skipped
    -- Detecting C compile features
    -- Detecting C compile features - done
    -- The CXX compiler identification is GNU 8.5.0
    -- Detecting CXX compiler ABI info
    -- Detecting CXX compiler ABI info - done
    -- Check for working CXX compiler: /Users/ilg/tmp/my-project/xpacks/.bin/g++ - skipped
    -- Detecting CXX compile features
    -- Detecting CXX compile features - done
    -- The ASM compiler identification is GNU
    -- Found assembler: /Users/ilg/tmp/my-project/xpacks/.bin/gcc
    -- Compiler: GNU 8.5.0
    -- Build type: Release
    -- Project path: /Users/ilg/tmp/my-project
    -- PATH: /Users/ilg/tmp/my-project/xpacks/.bin:/Users/ilg/tmp/my-project/xpacks/.bin:/Users/ilg/tmp/my-project/xpacks/.bin:/Users/ilg/Library/Python/3.7/bin:/Library/Frameworks/Python.framework/Versions/3.7/bin:/Users/ilg/.nvm/versions/node/v14.16.0/bin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin
    -- ==> application
    -- Configuring done
    -- Generating done
    -- Build files have been written to: /Users/ilg/tmp/my-project/build/release
    > xpm run build-all
    > xpm run build --config Debug
    > cmake -S meta -B build/debug -G Ninja -D CMAKE_BUILD_TYPE=Debug -D CMAKE_EXPORT_COMPILE_COMMANDS=ON
    -- CMake version: 3.19.8-g290a19d
    -- Compiler: GNU 8.5.0
    -- Build type: Debug
    -- Project path: /Users/ilg/tmp/my-project
    -- PATH: /Users/ilg/tmp/my-project/xpacks/.bin:/Users/ilg/tmp/my-project/xpacks/.bin:/Users/ilg/tmp/my-project/xpacks/.bin:/Users/ilg/Library/Python/3.7/bin:/Library/Frameworks/Python.framework/Versions/3.7/bin:/Users/ilg/.nvm/versions/node/v14.16.0/bin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin
    -- ==> application
    -- Configuring done
    -- Generating done
    -- Build files have been written to: /Users/ilg/tmp/my-project/build/debug
    > cmake --build build/debug --verbose
    [1/3] /Users/ilg/tmp/my-project/xpacks/.bin/gcc -DDEBUG -I/Users/ilg/tmp/my-project/include -I/Users/ilg/tmp/my-project/libs/adder/include -O0 -g3 -fmessage-length=0 -fsigned-char -ffunction-sections -fdata-sections -flto -std=gnu11 -MD -MT CMakeFiles/application.dir/Users/ilg/tmp/my-project/libs/adder/src/add.c.obj -MF CMakeFiles/application.dir/Users/ilg/tmp/my-project/libs/adder/src/add.c.obj.d -o CMakeFiles/application.dir/Users/ilg/tmp/my-project/libs/adder/src/add.c.obj -c /Users/ilg/tmp/my-project/libs/adder/src/add.c
    [2/3] /Users/ilg/tmp/my-project/xpacks/.bin/g++ -DDEBUG -I/Users/ilg/tmp/my-project/include -I/Users/ilg/tmp/my-project/libs/adder/include -O0 -g3 -fmessage-length=0 -fsigned-char -ffunction-sections -fdata-sections -flto -std=gnu++17 -MD -MT CMakeFiles/application.dir/Users/ilg/tmp/my-project/src/hello-world.cpp.obj -MF CMakeFiles/application.dir/Users/ilg/tmp/my-project/src/hello-world.cpp.obj.d -o CMakeFiles/application.dir/Users/ilg/tmp/my-project/src/hello-world.cpp.obj -c /Users/ilg/tmp/my-project/src/hello-world.cpp
    [3/3] : && /Users/ilg/tmp/my-project/xpacks/.bin/g++ -O0 -g3 -fmessage-length=0 -fsigned-char -ffunction-sections -fdata-sections -flto -Wl,-dead_strip CMakeFiles/application.dir/Users/ilg/tmp/my-project/src/hello-world.cpp.obj CMakeFiles/application.dir/Users/ilg/tmp/my-project/libs/adder/src/add.c.obj -o hello-world   && :
    > xpm run build --config Release
    > cmake -S meta -B build/release -G Ninja -D CMAKE_BUILD_TYPE=Release -D CMAKE_EXPORT_COMPILE_COMMANDS=ON
    -- CMake version: 3.19.8-g290a19d
    -- Compiler: GNU 8.5.0
    -- Build type: Release
    -- Project path: /Users/ilg/tmp/my-project
    -- PATH: /Users/ilg/tmp/my-project/xpacks/.bin:/Users/ilg/tmp/my-project/xpacks/.bin:/Users/ilg/tmp/my-project/xpacks/.bin:/Users/ilg/Library/Python/3.7/bin:/Library/Frameworks/Python.framework/Versions/3.7/bin:/Users/ilg/.nvm/versions/node/v14.16.0/bin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin
    -- ==> application
    -- Configuring done
    -- Generating done
    -- Build files have been written to: /Users/ilg/tmp/my-project/build/release
    > cmake --build build/release --verbose
    [1/3] /Users/ilg/tmp/my-project/xpacks/.bin/gcc  -I/Users/ilg/tmp/my-project/include -I/Users/ilg/tmp/my-project/libs/adder/include -O3 -DNDEBUG -fmessage-length=0 -fsigned-char -ffunction-sections -fdata-sections -flto -std=gnu11 -MD -MT CMakeFiles/application.dir/Users/ilg/tmp/my-project/libs/adder/src/add.c.obj -MF CMakeFiles/application.dir/Users/ilg/tmp/my-project/libs/adder/src/add.c.obj.d -o CMakeFiles/application.dir/Users/ilg/tmp/my-project/libs/adder/src/add.c.obj -c /Users/ilg/tmp/my-project/libs/adder/src/add.c
    [2/3] /Users/ilg/tmp/my-project/xpacks/.bin/g++  -I/Users/ilg/tmp/my-project/include -I/Users/ilg/tmp/my-project/libs/adder/include -O3 -DNDEBUG -fmessage-length=0 -fsigned-char -ffunction-sections -fdata-sections -flto -std=gnu++17 -MD -MT CMakeFiles/application.dir/Users/ilg/tmp/my-project/src/hello-world.cpp.obj -MF CMakeFiles/application.dir/Users/ilg/tmp/my-project/src/hello-world.cpp.obj.d -o CMakeFiles/application.dir/Users/ilg/tmp/my-project/src/hello-world.cpp.obj -c /Users/ilg/tmp/my-project/src/hello-world.cpp
    [3/3] : && /Users/ilg/tmp/my-project/xpacks/.bin/g++ -O3 -DNDEBUG -fmessage-length=0 -fsigned-char -ffunction-sections -fdata-sections -flto -Wl,-dead_strip CMakeFiles/application.dir/Users/ilg/tmp/my-project/src/hello-world.cpp.obj CMakeFiles/application.dir/Users/ilg/tmp/my-project/libs/adder/src/add.c.obj -o hello-world   && :
    > xpm run execute-all
    > xpm run execute --config Debug
    > build/debug/hello-world
    Hello World!
    (in debug mode)
    Check adder lib: 41 + 1 = 42
    > xpm run execute --config Release
    > build/release/hello-world
    Hello World!
    (in release mode)
    (no asserts)
    Check adder lib: 41 + 1 = 42
    %

    Toolchain

    By default, the generated projects use the xPack GNU Compiler Collection, which is a cross-platform GCC.

    It is also possible to use the compiler available in the system.

    Windows specifics

    On Windows the projects generated by the template were tested with:

    Known problems

    • On Windows, the VS Code IntelliSense logic does not properly identify the toolchain when installed via npm/xpm (#28); the workaround is to make the invokations use explicit program extensions like gcc.cmd. The CMake scripts were patched to do so; the meson and make scripts will be patched at a later date; for now they need to be patched manually after the project is generated.

    Maintainer & developer info

    This page is addressed to those who plan to use the template directly.

    For maintainer and developer info, please see the README-MAINTAINER and README-DEVELOPER pages.

    License

    The original content is released under the MIT License, with all rights reserved to Liviu Ionescu.

    Install

    npm i @xpack/hello-world-template

    DownloadsWeekly Downloads

    12

    Version

    0.5.2

    License

    MIT

    Unpacked Size

    3.6 MB

    Total Files

    1005

    Last publish

    Collaborators

    • ilg