From 41b32ebfcdd7e4d1e93eb605481196fa2cc7185d Mon Sep 17 00:00:00 2001 From: Jamie Mason Date: Wed, 23 Nov 2022 23:12:15 +0000 Subject: [PATCH] docs(readme): warn against managing projects with filter --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 84d7c001..3e2b425b 100644 --- a/README.md +++ b/README.md @@ -362,6 +362,13 @@ or `--workspace` then only the options you provide will be searched. A string which will be passed to `new RegExp()` to match against package names that should be included. +> ⚠️ `filter` was originally intended as a convenience to be used from the +> command line to filter the output of `syncpack list`, **it is not recommended +> to add this to your config file to manage your project more generally**. +> +> Instead use [`versionGroups`](#versiongroups) and/or +> [`semverGroups`](#semvergroups). + ### `indent` The character(s) to be used to indent your package.json files when writing to