Add a npm installer package #342
Conversation
Fixes remaining sonarcloud violations not associated with todos. Adds tests to slightly improve coverage, as well as updates the github action used to upload coverage. Reported coverage on the project has decreased significantly as a result of this update, seemingly because of a difference in the way conditional statements are counted. Removes some now-obsolete #define values.
Refactors validation code so that string lengths are re-used after computation. `unlikely` statements have also been added to several validation calls. Also corrects potential deadlocks in the set hostname and procid functions that could be triggered by a value that failed validation.
Continuing the elimination of include/private/config/wrapper.h by moving another function into its own wrapper header. Also adds a gitignore rule for DS_Store files so that they are not inadvertently added in the future. This fixes #298, which can be referenced for more details.
Fixes warnings encountered during MinGW builds due to type mismatches. Also updates the build documentation to include more specific instructions for MinGW platforms. This partially resolves #318, which can be referenced for more details. It does not fix the build on older versions of MinGW, which will be handled in a separate change if needed. The additional information on building on MinGW and MSYS2 may also help #303.
Often a structure can be stored on the stack instead of the heap, which can in turn lead to better performance. This change adds support for stack allocation of entry, element, and param structures. It also makes use of this capability for some internally stored structures, in an effort to reduce heap memory usage and improve performance.
Adds validation for param values as valid UTF-8 strings only, as specified by RFC 5424. This fixes #322, which can be referenced for more information.
Add a CITATION.cff file in Citation File Format to make referencing the project straightforward.
Library compilation and functionality was not portable enough to support builds in ANSI C only environments, where some functions such as gmtime_r and getaddrinfo are not provided. This change updates the configuration and build to support these environments, and improves documentation in the affected areas of functionality to more clearly convey caveats and limitations. This fixes #325, which can be referenced for more details.
Fuzzing tests provide an avenue to identify potential security issues in functionality. This change adds a framework to write and run fuzzers against stumpless, including a fuzzer for the stumpless_add_message_str function. Corpus directories are also included, and their contents can be used in unit tests as well as fuzzing. This is intended to facilitate both testing against problems that a fuzzer finds and improving the seed for future fuzzing.
Adds specific documentation about the extra requirements needed to build and run fuzzing tests. This fixes #334, which can be referenced for more information.
Adds generation of a pkg-config for installation, improving dependency discover on Linux systems. This fixes #339, which can be referenced for more information.
|
I don't understand exactly what the request is, or how the title and description relate to the changes included in the pull request. Can you share more details on what download methods you tried and how they failed? Screenshots or copied commands and their output would be most helpful. I am unfamiliar with using NPM as a way to install a native library. Can you share an example of another project doing this, or more details on what you believe an "npm installer package" would do? |
|
Oh sorry. I did not know that. To get a NPM script you need node.js, which comes with NPM. To be honest this probably won't work since it works with JavaScript and this is C. But there is ruby in your code so there is a chance to make it using the gem install command. If you need more reference please check these two popular repositories that use NPM and gem.
|
|
Currently the installation packages provided are
Are you able to share what these steps were and what the failure was? I'd like to fix any problems that exist with the If you have a request for another package manager, please open a feature request describing what you want and we will see if we can add it. Managers for other languages such as npm and RubyGems are not something we'll be able to support, but there are many others that should be possible.
The Ruby code in the project is used for development and build steps, and isn't part of the library itself. Making a gem for this project wouldn't be a natural install option, since it isn't a Ruby-based tool. A Ruby runtime isn't even a requirement for using the library itself, only during development, and for the build of the C++ bindings. |
|
In that case, is there a way to download it using the command line? Or is there any way I can fix this? (Sorry for the long wait, I had some work to do.) I am a web developer, so I won't know as much. But I did some research and found this-
|
|
Right now the best command-line installation method is to build from the source, following along with the steps outlined in the install guide. If you notice missing info in this please let me know: it should be good for you as long as you have cmake and any build toolchain installed. If there is a specific package manager you would like to use in the future, please open a separate issue for it and I'll see about getting the project in there. |
|
I saw the installation guide and I didn't see anything from the source. But it seems as though there is a
I am not familiar in C or CMake. I do have knowledge to install JavaScript on the command-line. Can you provide some information on CMake? I do have a build toolchain- Gulp. Anyway, my problem is to check the debian and and the C++ method. Otherwise, please give me the installation script if you want me to point out the problem. |
|
Since Gulp is a Javascript build tool, it's unlikely to help here. CMake serves a similar purpose, typically for C and C++ projects. CMake generates build scripts for various C compilation toolchains such as Make and GCC, Visual Studio, and others. If you're working in MinGW you probably already have these installed, so the build from source commands should work. If you need a command-line installation method for the MSI, you can use msiexec to accomplish this. Windows PowerShell will let you do an Invoke-WebRequest -Uri https://github.com/goatshriek/stumpless/releases/download/v2.1.0/stumpless-cpp-2.1.0-win64.msi -OutFile stumpless-cpp-2.1.0-win64.msi
msiexec /i stumpless-cpp-2.1.0-win64.msiIf you need a set of commands to install on Debian, you could do this with a wget followed by dpkg to accomplish the same thing: wget https://github.com/goatshriek/stumpless/releases/download/v2.1.0/stumpless-cpp-2.1.0-amd64.deb
sudo dpkg -i stumpless-cpp-2.1.0-amd64.deb |
|
I tried the PowerShell code. Yes, it did install the Like you said, I installed CMake. But can the command work in PowerShell? I am not as familiar with MinGW than other |
|
Can you share a screenshot of either failure? CMake itself can run from PowerShell if you have installed it to your system path, but it may not find your compiler. Seeing the commands you've tried and their output is probably the best next step. |
|
Sure. Here is a screenshot of the failure- I do not have much experience with PowerShell. I have read through how to use CMake and I'm confident that I can use it without PowerShell. |
|
Hmm, I can reproduce that error by running the command with a file that doesn't exist. Can you share the output of stumpless> dir
Volume in drive C has no label.
Volume Serial Number is <...>
Directory of C:\Users\<username>\Downloads
05/25/2023 07:23 AM <DIR> .
05/25/2023 07:23 AM <DIR> ..
05/23/2023 05:41 AM 532,480 stumpless-cpp-2.1.0-win64.msi
1 File(s) 532,480 bytes
2 Dir(s) <...> bytes free
stumpless> msiexec /i stumpless-cpp-2.1.0-win64.msi
stumpless> |
|
Yes, it does look kind of like that. Unfortunately, the code has been looking a lot different. It even looks like it's supposed to be correct and the normal information that should be given. But something popped up that looks like can be related to the code (I am assuming this because the installer wants to be administrator and this is something related to it.
Anyway, I have another theory on why this is not working. It maybe is a 32-bit application. Windows 11 does not support 32-bit applications. I think your code got mixed up. |
|
There is both a 32-bit and 64-bit version of the installer - if you've used the 64-bit MSI then there should be no architecture incompatibility. |
Adds several tests for stumpless_set_wel_insertion_string and its handling of invalid UTF-8 strings in several different states. This fixes #273, which can be referenced for more details.
Corrects an issue with the localization validation script that could not handle string literal concatenation. This exposed some other standardization issues in localization headers, which this change also corrects.
|
Closing due to deleted requestor account. |
I tried downloading it through cmd and mingw using the debian and the C++ method, but it says connection failed for some reason. Please fix this as I have seen others do it