check:vendor

Table of contents

  1. Introduction
  2. Reporting without failing
  3. Listing every file
  4. Running it in CI
  5. Reference
    1. What it looks for
    2. Where it looks

Introduction

check:vendor finds Keenthemes code, the Metronic theme and its icons, in your selected product and in the features it declares. Metronic’s licence does not allow redistributing it, so no product of the line and no feature may carry it. A feature written against it also breaks once the product that ships Metronic’s files drops them.

splent check:vendor
  check:vendor  my_first_app
  ------------------------------------------------------------
  splent_feature_reports@v0.1.1  (src/)
    ✗ splent_io/splent_feature_reports/assets/js/charts.js:2  ki-duotone, data-kt- (6 matches)
    ✗ splent_io/splent_feature_reports/hooks.py:21  ki-duotone (1 match)
    ✗ splent_io/splent_feature_reports/templates/reports/index.html:26  ki-duotone, data-kt- (10 matches)
  splent_feature_reviews@v0.1.0  (src/)
    ✗ splent_io/splent_feature_reviews/templates/reviews/_review_widget.html:10  ki-duotone (4 matches)

  ✗ 4 files with Keenthemes code, in 2 features
    Replace it with Bootstrap, feather icons or code of your own. In a feature, that takes a release the product then pins.

Each line gives the file, its first match, the patterns found and how many. It exits 1 when anything is found. With nothing found it ends with ✅ No Keenthemes code in <product> or its <n> features.


Reporting without failing

splent check:vendor --warn

Use it while a product moves off Keenthemes. It reports the same files, marked ⚠️ instead of ✗, and exits 0.


Listing every file

splent check:vendor --all

Without --all each place lists ten files and counts the rest, as … and <n> more files (--all lists them).


Running it in CI

The validate job of splent-validate.yml runs splent check:vendor, without --warn, after it resolves the features of both environments (see Continuous integration).

To add the step to an existing workflow, write it again with product:sync-template --ci once splent check:vendor passes, since the job fails until the last file is gone.


Reference

Option Description
--warn Report and exit 0
--all List every file found

What it looks for

Pattern What it is
KTUtil, KTComponents, KTApp, KTMenu, KTStepper The globals Metronic’s JavaScript defines, at the start of a word
ki-duotone, ki-outline, ki-solid The classes of Keenicons, its icon font
data-kt- Its data attributes
keenthemes, Metronic The names in any case, Metronic as a whole word

Duotune, Keenthemes’ SVG icon set, carries no mark of its own, so a file whose path names duotune, keenicons, keenthemes or metronic is reported as duotune in its path.

Where it looks

Place What is searched
The product Its whole tree, except features/, instance/ and uploads/
Each feature in features, features_dev and features_prod The src/ of the copy the product runs, the release it pins or the working copy of an editable one

Everywhere it leaves out tests/, node_modules/, __pycache__/, hidden folders such as .git, and binary files. A feature with no local copy is not searched, and the output says so with ℹ️ Not searched, no local copy: <features>. Run splent product:resolve first so each feature has one.

It needs a selected product (SPLENT_APP).


Back to top

splent. Distributed by an LGPL license v3. Contact us: drorganvidez@us.es