fontist 3.0.35 → 3.0.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ade396e3811d8a2df5ae15cce0af89df56bf723bc9c915f42f72b487073de39
-  data.tar.gz: ab738ce85235d7cdf811c0cf51ec23b28488637d09f7c9bc77ca9b91c8afb2e6
+  metadata.gz: d9740ba780da1a789c85954976ffa0d49227705ee62a24dc266dbc4448e63d84
+  data.tar.gz: 05dd6af4bb8303c4ee4807c6b0a1b2f24607dffbd448352ba9dc8dd145d924c2
 SHA512:
-  metadata.gz: 69e7e9ef3fd5200939a9c2820cd58e19af2cef6890ee4f91b317c227c5e33b46d5ae71046663e565c4883a89bda147a39f9c723a51383ab03203c8e59ac73fcf
-  data.tar.gz: 3e08dc9b127f6e313ddf2f6fcae9fa174832d57c0ae0bc4bb7730094f2fbc05a0171966ce1d793f1af87ef08808b88b0771630acf374347210dcb6ac8bc10f41
+  metadata.gz: 8663ae799c949874b9b61a23c382812f6654a379702f93907530ed8602158725ebf83dd9320cde2539b6e757e51c209833efdc167f820f7d4d695983ad0c27f0
+  data.tar.gz: 6f01160c9dfc7c11ace56ebac1b92c332be258716b64bd0eb8a95d8271913efc14c1499897c962e170cee914385f1ccbd79b9157f2060582f3ace220b7f3ccde

data/README.adoc

@@ -363,6 +363,20 @@ Keeps only the glyphs for those characters. Options can be combined with
 fontist pack family.ttc Regular.ttf Bold.ttf
 ----
 
+==== Transform a font file you already have
+
+`fontist convert` runs the same operations on a local file, without
+installing anything. Each output is written next to the source unless
+`--output` (or `--output-dir`) is given, and the source is never overwritten.
+
+[source,sh]
+----
+fontist convert format Lato-Regular.ttf woff2
+fontist convert extract NotoSansCJK.ttc --index 1 --output-dir out
+fontist convert instance "Roboto[wdth,wght].ttf" wght=300,wdth=90
+fontist convert subset Lato-Regular.ttf --unicodes "U+0020-007E" --text "é"
+----
+
 ==== Ruby API
 
 [source,ruby]

data/docs/.vitepress/config.ts

@@ -204,6 +204,7 @@ export default defineConfig({
             { text: "repo", link: "/cli/repo" },
             { text: "fontconfig", link: "/cli/fontconfig" },
             { text: "import", link: "/cli/import" },
+            { text: "convert", link: "/cli/convert" },
             { text: "index", link: "/cli/index-cmd" },
             { text: "create-formula", link: "/cli/create-formula" },
           ],

data/docs/cli/convert.md

@@ -0,0 +1,38 @@
+# fontist convert
+
+Transform a font file you already have, using [Fontisan](https://github.com/fontist/fontisan). Nothing is installed.
+
+## Syntax
+
+```sh
+fontist convert format FONT_FILE FORMAT [--output FILE]
+fontist convert extract COLLECTION --index N [--output-dir DIR]
+fontist convert instance FONT_FILE AXES [--output FILE]
+fontist convert subset FONT_FILE [--unicodes LIST] [--text TEXT] [--output FILE]
+```
+
+## Subcommands
+
+| Subcommand | Description |
+|------------|-------------|
+| `format` | Convert to `ttf`, `otf`, `woff` or `woff2` |
+| `extract` | Write one member of a TTC/OTC collection as a standalone font |
+| `instance` | Write a static instance of a variable font at the given axis values |
+| `subset` | Keep only the glyphs for the given characters |
+
+By default each output is written next to the source: `Lato.woff2`, `Font-wght300.ttf`, `Lato-subset.ttf`. A command never overwrites its source font.
+
+## Examples
+
+```sh
+fontist convert format Lato-Regular.ttf woff2
+fontist convert extract NotoSansCJK.ttc --index 1 --output-dir out
+fontist convert instance "Roboto[wdth,wght].ttf" wght=300,wdth=90
+fontist convert subset Lato-Regular.ttf --unicodes "U+0020-007E" --text "é"
+```
+
+Axis tags and values are checked against the font: an unknown axis or a value outside its range fails with an error.
+
+## Related Commands
+
+- [fontist install](/cli/install) - The same operations while installing (`--format`, `--collection-index`, `--instance`, `--subset-*`)

data/docs/cli/index.md

@@ -23,6 +23,7 @@ Complete command-line interface reference for Fontist.
 | [`fontist repo`](/cli/repo) | Custom repositories |
 | [`fontist fontconfig`](/cli/fontconfig) | Fontconfig integration |
 | [`fontist import`](/cli/import) | Import fonts |
+| [`fontist convert`](/cli/convert) | Convert, extract, instance or subset a font file |
 | [`fontist index`](/cli/index-cmd) | System font index |
 | [`fontist create-formula`](/cli/create-formula) | Create formulas |
 

data/lib/fontist/cli.rb

@@ -33,6 +33,7 @@ module Fontist
       Fontist::Errors::CollectionIndexError => [STATUS_UNKNOWN_ERROR],
       Fontist::Errors::UnsupportedTranscodeError => [STATUS_UNKNOWN_ERROR],
       Fontist::Errors::SourceNotFoundError => [STATUS_UNKNOWN_ERROR],
+      Fontist::Errors::InstanceError => [STATUS_UNKNOWN_ERROR],
       Fontist::Errors::SizeLimitError => [
         STATUS_SIZE_LIMIT_ERROR,
         :append,
@@ -470,6 +471,10 @@ module Fontist
     desc "config SUBCOMMAND ...ARGS", "Manage fontist config"
     subcommand "config", Fontist::ConfigCLI
 
+    desc "convert SUBCOMMAND ...ARGS",
+         "Convert, extract, instance or subset a font file"
+    subcommand "convert", Fontist::ConvertCLI
+
     desc "cache SUBCOMMAND ...ARGS", "Manage fontist cache"
     subcommand "cache", Fontist::CacheCLI
 

data/lib/fontist/convert_cli.rb

@@ -0,0 +1,88 @@
+module Fontist
+  # `fontist convert ...`: Fontisan operations on font files the user
+  # already has, without installing anything.
+  class ConvertCLI < Thor
+    include CLI::ClassOptions
+
+    desc "format FONT_FILE FORMAT",
+         "Convert FONT_FILE to FORMAT (ttf, otf, woff, woff2)"
+    option :output, aliases: :o,
+                    desc: "Output file (default: FONT_FILE, new extension)"
+    def to_format(source, target)
+      default = replace_ext(source, ".#{target.to_s.downcase}")
+      write_font do
+        output = output_for(source, default)
+        FontOperations::Convert.call(source, target, output)
+      end
+    end
+    map "format" => :to_format
+
+    desc "extract COLLECTION", "Write one member of a TTC/OTC collection"
+    option :index, type: :numeric, required: true,
+                   desc: "Zero-based member index"
+    option :output_dir, desc: "Output directory (default: next to COLLECTION)"
+    def extract(collection)
+      dir = options[:output_dir] || File.dirname(collection)
+      write_font do
+        FontOperations::Extract.call(collection, index: options[:index],
+                                                 output_dir: dir)
+      end
+    end
+
+    desc "instance FONT_FILE AXES",
+         "Write a static instance of a variable font (e.g. wght=300,wdth=90)"
+    option :output, aliases: :o,
+                    desc: "Output file (default: FONT_FILE named after AXES)"
+    def instance(source, axes)
+      write_font do
+        coords = FontOperations::Instance.parse(axes)
+        name = FontOperations::Instance.file_name(File.basename(source), coords)
+        default = File.join(File.dirname(source), name)
+        FontOperations::Instance.call(source, output_for(source, default),
+                                      coordinates: coords)
+      end
+    end
+
+    desc "subset FONT_FILE", "Keep only the glyphs for the given characters"
+    option :unicodes, desc: "Codepoints to keep (e.g. 'U+0020-007E,U+00E9')"
+    option :text, desc: "Characters to keep"
+    option :output, aliases: :o,
+                    desc: "Output file (default: FONT_FILE with -subset)"
+    def subset(source)
+      default = replace_ext(source, "-subset#{File.extname(source)}")
+      write_font do
+        FontOperations::Subset.call(source, output_for(source, default),
+                                    unicodes: options[:unicodes],
+                                    text: options[:text])
+      end
+    end
+
+    private
+
+    def write_font
+      handle_class_options(options)
+      path = yield
+      Fontist.ui.success("Written to #{path}")
+      CLI::STATUS_SUCCESS
+    rescue Errors::GeneralError => e
+      Fontist.ui.error(e.message)
+      CLI::STATUS_UNKNOWN_ERROR
+    end
+
+    # The given --output, or +default+; never the source itself.
+    def output_for(source, default)
+      output = options[:output] || default
+      if File.expand_path(output) == File.expand_path(source)
+        raise FontOperations::Error,
+              "Output would overwrite #{source}. Give a different --output."
+      end
+
+      output
+    end
+
+    def replace_ext(path, suffix)
+      File.join(File.dirname(path),
+                File.basename(path, File.extname(path)) + suffix)
+    end
+  end
+end

data/lib/fontist/version.rb

@@ -1,3 +1,3 @@
 module Fontist
-  VERSION = "3.0.35".freeze
+  VERSION = "3.0.36".freeze
 end

data/lib/fontist.rb

@@ -82,6 +82,7 @@ module Fontist
   autoload :CLI, "#{__dir__}/fontist/cli"
   autoload :CacheCLI, "#{__dir__}/fontist/cache_cli"
   autoload :ConfigCLI, "#{__dir__}/fontist/config_cli"
+  autoload :ConvertCLI, "#{__dir__}/fontist/convert_cli"
   autoload :FontconfigCLI, "#{__dir__}/fontist/fontconfig_cli"
   autoload :ImportCLI, "#{__dir__}/fontist/import_cli"
   autoload :IndexCLI, "#{__dir__}/fontist/index_cli"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fontist
 version: !ruby/object:Gem::Version
-  version: 3.0.35
+  version: 3.0.36
 platform: ruby
 authors:
 - Ribose Inc.
@@ -277,6 +277,7 @@ files:
 - docs/api/manifest.md
 - docs/cli/cache.md
 - docs/cli/config.md
+- docs/cli/convert.md
 - docs/cli/create-formula.md
 - docs/cli/exit-codes.md
 - docs/cli/fontconfig.md
@@ -343,6 +344,7 @@ files:
 - lib/fontist/collection_file.rb
 - lib/fontist/config.rb
 - lib/fontist/config_cli.rb
+- lib/fontist/convert_cli.rb
 - lib/fontist/css.rb
 - lib/fontist/css/google_family.rb
 - lib/fontist/css/local.rb