React-snap: Add exclude option

Created on 10 Apr 2019 · 9Comments · Source: stereobooster/react-snap

Feature Request

Is your feature request related to a problem? Please describe.
Need a way to ignore some paths, especially when used together with crawl: true (default) option.

Describe the solution you'd like
exclude option to ignore some paths. Exclude suppose to be an array of glob patterns.

For example:

pattern /a/b/c would ignore /a/b/c and /a/b/c/, but not /a/b/c/d.
pattern /a/b/c/* would ignore /a/b/c and /a/b/c/ and /a/b/c/d.

To avoid confusion there should be additional check for include option to check that people don't use glob patterns for include, and if they do there suppose to be a message explaining why it is not possible to use glob patterns for include.

To avoid confusion there should be additional check for include and exclude, so they don't have intersection, otherwise people can be confused, why some pages are not crawled, even so they present in include.

Describe alternatives you've considered
list all required pages by and and disable crawl, which is not convenient

Teachability, Documentation, Adoption, Migration Strategy
Option is backward compatible.

My concerns were that this option will be tricky for end users, but 2 additional checks (described above) should prevent confusion.

enhancement help wanted

Source

stereobooster

👍26

Most helpful comment

The approach described above would be sufficient. This would make react-snap especially useful for web applications that only need the index to be static (e.g. a landing/marketing page for SEO) but where there is no need to have the rest of the application have snapshots.