📦 version 3 (#4756)

* Validate input to BadgeFactory.create() (#3875)

* validate input to create()

* remove deprecated properties (#3881)

* remove BadgeFactory class (#3884)

* Template literal templates (#4459)

- Remove use of the doT template library and move to generating SVG output using javascript template literals.
- Drop SVGO and mostly manually implement the optimisations.
- Add a bunch more tests

Co-authored-by: Paul Melnikow <github@paulmelnikow.com>

* drop raster support in package CLI (#4523)

* drop raster support in package CLI
* update docs

* rename gh-badges package to badge-maker

* rename gh-badges dir to badge-maker

* update relative imports and other refs to in parent dir

'gh-badges' --> 'badge-maker'

* update snyk service tests

This change is only tangentially related

We've used the shields repo as an example for these tests so
moving files around in our repo has a knock-on effect on them

* add missing type hints to dev style page

* write the changelog/migration guide for v3

* use extension in README CLI example

* update CLI help

whoops - missed this in #4523

* bump version

* update for self-hosting users

* README updates

* drop .format param from CLI, always output SVG

* Change text[] to label and message, Remove JSON output

- Change text[] to label and message
- Fix message only badge
- Remove JSON output format
- Update the docs

* update package-lock

* rename 'template' to 'style'

* handle invalid styles in coalesceBadge

* ensure makeBadge is passed a string for template in coalesceBadge()

issue #4925

* fix (logo/no label text/label color specified) case

issue #4926

* add example of (logo/no label text/label color specified) to style debug page

* update type defs

* padding fix for FTB style

Co-authored-by: Paul Melnikow <github@paulmelnikow.com>

doc/code-walkthrough.md

@@ -7,7 +7,7 @@ The Shields codebase is divided into several parts:
 1.  The frontend (about 7% of the code)
     1. [`frontend`][frontend]
 2.  The badge renderer (which is available as an npm package)
-    1.  [`gh-badges`][gh-badges]
+    1.  [`badge-maker`][badge-maker]
 3.  The base service classes (about 8% of the code, and probably the most important
     code in the codebase)
     1.  [`core/base-service`][base-service]
@@ -24,7 +24,7 @@ The Shields codebase is divided into several parts:
     1.  [`lib/suggest.js`][suggest]
 
 [frontend]: https://github.com/badges/shields/tree/master/frontend
-[gh-badges]: https://github.com/badges/shields/tree/master/gh-badges
+[badge-maker]: https://github.com/badges/shields/tree/master/badge-maker
 [base-service]: https://github.com/badges/shields/tree/master/core/base-service
 [server]: https://github.com/badges/shields/tree/master/core/server
 [token-pooling]: https://github.com/badges/shields/tree/master/core/token-pooling
@@ -36,7 +36,7 @@ The tests are also divided into several parts:
 1.  Unit and functional tests of the frontend
     1.  `frontend/**/*.spec.js`
 2.  Unit and functional tests of the badge renderer
-    1.  `gh-badges/**/*.spec.js`
+    1.  `badge-maker/**/*.spec.js`
 3.  Unit and functional tests of the core code
     1.  `core/**/*.spec.js`
 4.  Unit and functional tests of the service helper functions

doc/self-hosting.md

@@ -78,7 +78,7 @@ $ docker run --rm -p 8080:80 --name shields shields
 # or if you have shields.env file, run the following instead
 $ docker run --rm -p 8080:80 --env-file shields.env --name shields shields
 
-> gh-badges@1.1.2 start /usr/src/app
+> badge-maker@3.0.0 start /usr/src/app
 > node server.js
 
 http://[::1]/