Package Health Score

49 / 100

security
Security review needed
popularity
Limited
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version			Vulnerabilities	License Risk
7.0.2	\|	08/2023	0 C 0 H 0 M 0 L	0 H 0 M 0 L
6.0.0	\|	04/2020	0 C 0 H 0 M 0 L	0 H 0 M 0 L
5.6.4	\|	10/2019	0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.13.5	\|	03/2019	0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.12.3	\|	01/2019	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

BSD-3-Clause

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (50)

GitHub Stars: 310
Forks: 81
Contributors: 30

Direct Usage Popularity

The npm package windshaft receives a total of 50 downloads a week. As such, we scored windshaft popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package windshaft, we found that it has been starred 310 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 30
Funding: No

With more than 10 contributors for the windshaft repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like windshaft is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 25
Open PR: 12
Last Release: 1 year ago
Last Commit: 1 year ago

Further analysis of the maintenance status of windshaft based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for windshaft is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: ^12.16.3

Age: 13 years
Dependencies: 13 Direct
Versions: 254
Install Size: 148 kB
Dist-tags: 1
# of Files: 50
Maintainers: 16
TS Typings: No

windshaft has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Windshaft

A Node.js map tile library for PostGIS and torque.js, with CartoCSS styling.

Can render arbitrary SQL queries
Generates image and UTFGrid interactivity tiles
Accepts, stores, serves, and applies map styles written in CartoCSS
Supports re-projections

Windshaft is a library used by CARTO, a location intelligence and data visualization tool.

Examples

Playing with colors by @andrewxhill Circumpolar Arctic Vegetation by @andrewxhill Bolivia deforestation by @saleiva Traffic accidents by @rochoa

Build

Requirements:

Node 10.x (npm 6.x)
PostgreSQL >= 10.0
PostGIS >= 2.4
CARTO Postgres Extension >= 0.24.1
Redis >= 4
libcairo2-dev, libpango1.0-dev, libjpeg8-dev and libgif-dev for server side canvas support
C++11 to build internal dependencies. When there's no pre-built binaries for your OS/architecture distribution.

Install

To fetch and build all node-based dependencies, run:

$ npm install

Installing Mapnik

Note: only needed while developing Mapnik and/or node-mapnik.

node-mapnik comes compiled for some platforms and architectures, in case you need it you can always compile, package and install it manually. The recommended option is via binaries, see mason and install Mapnik like:

$ mason install mapnik

Where `` is the latest released version of Mapnik. You can also use other alternatives:

Usage

Probably one of the more advanced uses of Windshaft library can be found at Windshaft-cartodb project.

Test

$ npm test

Coverage

$ npm run cover

Open ./coverage/lcov-report/index.html.

Docker support

We provide docker images just for testing and continuous integration purposes:

You can find instructions to install Docker, download, and update images here.

Useful `npm` scripts

Run test in a docker image with a specific Node.js version:

$ DOCKER_IMAGE= NODE_VERSION= npm run test:docker

Where:

``: the tag of required docker image, e.g. carto/nodejs-xenial-pg1121:latest
``: the Node.js version, e.g. 10.15.1

In case you need to debug:

$ DOCKER_IMAGE= npm run docker:bash

Troubleshooting

Fonts: Invalid value for text-face-name

You need to install fonts at system level to be able to use them. If you face an issue like Invalid value for text-face-name, the type font is expected. DejaVu Sans Book (of type string) was given. probably you don't have the required fonts, try to install DejaVu fonts or any other font needed.

Contributing

The issue tracker: Github.
We love Pull Requests from everyone, see contributing to Open Source on GitHub.
You'll need to sign a Contributor License Agreement (CLA) before submitting a Pull Request. Learn more here.

Versioning

We follow SemVer for versioning. For available versions, see the tags on this repository.

License

This project is licensed under the BSD 3-clause "New" or "Revised" License. See the LICENSE file for details.

windshaft dependencies

carto debug canvas semver request torque.js grainstore png-to-jpeg redis-mpool cartodb-psql @carto/mapnik @carto/cartonik cartodb-query-tables

windshaft development dependencies

nyc step mocha redis eslint express eslint-plugin-node eslint-plugin-import eslint-plugin-promise eslint-config-standard eslint-plugin-standard

FAQs

What is windshaft?

A Node.js map tile library for PostGIS with CartoCSS styling. Visit Snyk Advisor to see a full health score report for windshaft, including popularity, security, maintenance & community analysis.

Is windshaft popular?

The npm package windshaft receives a total of 50 weekly downloads. As such, windshaft popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is windshaft well maintained?

We found indications that windshaft is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is windshaft safe to use?

While scanning the latest version of windshaft, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 13 December-2024, at 13:38 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (50)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

Windshaft

Examples

Build

Install

Installing Mapnik

Usage

Test

Coverage

Docker support

Useful npm scripts

Troubleshooting

Fonts: Invalid value for text-face-name

Contributing

Versioning

License

windshaft dependencies

windshaft development dependencies

FAQs

What is windshaft?

Is windshaft popular?

Is windshaft well maintained?

Is windshaft safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues

Useful `npm` scripts