keystonejs/keystone-classic

add an option to ignore/filter files in the importer

Open

#3690 opened on Nov 12, 2016

View on GitHub
 (5 comments) (0 reactions) (0 assignees)JavaScript (14,656 stars) (2,288 forks)batch import
enhancementhelp wantedneeds input

Description

I'm currently trying to enhance a project, which is based on the MERN stack, with a keystone backend – something i successfully did with MERN 1.0 and Keystone 3.x. Now i ran into an issue while i tried to import my models via .import('models') caused by the importer who recursively went through the models folder and tried to add the test files as well.

models/
├── __tests__
│   └── post.spec.js
└── post.js

I now that this is a very specific use case but it could be handy to have some kind of filter mechianism in the importer if you're adding the keystone backend to an existing express based app.

Contributor guide

Tech stack
javascriptnodejs
Domain
backendtooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Node.js basicsFamiliarity with Keystone importer
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
The importer recursively loads files from a directory; this issue requests an option to exclude certain files (e.g., test files). Look at the existing import mechanism in the Keystone classic codebase, likely in `lib/importer.js` or similar. Investigate if there's already a glob or filter pattern; otherwise, implement a simple ignore list or regex option. Since the issue is old and no PR exists, consider discussing with maintainers on the current relevance and preferred API design.