Skip to content

Releases

v2.2.0

Choose a tag to compare

@AKlitbo AKlitbo released this 10 Nov 23:55

Added

  • Added --dev to the usage and help of paf build. Framework 6.0.0 and later build the face in the dev plugin's dev mode with it, and an older framework hands it on to pebble build, which refuses it.
  • Added units under plugins/, beside watchfaces/ and watchapps/, for a repo of plugin apps. A plugin app is a face whose pebble.appinfo.json sets "projectType": "plugin". paf syncs and builds it like any face, and paf status marks it (plugin app). paf build all --dev passes over it with a line saying so, since it has no watch code for dev mode to change.

Changed

  • paf pin and every command that readies a unit now refuse a tag before framework 6 for a unit holding a plugin app, since an older framework builds it as a watchface and stops partway. paf status and paf doctor show such a unit as a problem.
  • paf pin <unit> latest and the LATEST column of paf status now take the newest tag of framework 6 or later for a unit holding a plugin app, which is a candidate while framework 6 has no release.

v2.1.0

Choose a tag to compare

@AKlitbo AKlitbo released this 06 Nov 03:56

Changed

  • paf pin, paf sync, and every command that readies a unit now take a tag from framework 4 or any later framework, where they refused anything past framework 4. paf reads only the layout framework 4 settled, src/ copied into paf/ with its plugins and tools, so a later framework that keeps it needs no new paf. latest is now the newest such release, so paf pin <unit> latest moves a unit to framework 5.0.0. A framework 3 tag still needs paf 1.0.0.

v2.0.0

Choose a tag to compare

@AKlitbo AKlitbo released this 03 Oct 03:00

Added

  • Added paf format [unit] [--check], which runs the format a listed plugin offers through a format entry in its paf key, or the unit's own format script. With the code-style plugin that is Prettier over a unit's CSS, JSON, and YAML, once the unit turns it on. --check writes nothing and fails when a file would change.
  • Added paf check [unit], which runs every check the framework and the unit's listed plugins ship, in every unit or one, and fails at the end if any failed. Add it to a face repo's CI beside paf test, paf lint, and paf typecheck.
  • Added paf tool <face> <name> [args], which runs a tool a listed plugin names under tools in its paf key, such as the dev plugin's clay-preview and tap-walk. Every argument after the name reaches the tool as typed, -h and -- included, and paf exits with the tool's own code. For a tool only an unlisted plugin offers, it names the plugin to list.
  • Added the unit's own generators, under gen in paf.config.json: "gen": { "vibrant": { "script": "core/tools/vibrant/generate-vibrant.ts", "after": "clay" } }. script is a .ts file relative to the unit, since paf runs every script with node. after names the generator it runs after, and an optional when names a file or folder the face has to hold for paf gen <face> all to run it.

Changed

  • Breaking: A unit's file is paf.config.json rather than paf.json. It holds framework and commit as before, plus plugins, a map of the framework plugins the unit lists with each one's settings, and gen, a map of the unit's own generators. Rename the file by hand, and add plugins for each plugin the unit uses, such as "plugins": { "icons": { "sources": "../../vendor" }, "thumbnails": {} }. A repo with a paf.json left in any unit stops every command until it is moved.
  • Breaking: paf 2.0.0 reads only the framework 4 layout. paf pin refuses a framework 3 tag, and a tag from a later framework, which a later paf fills. paf sync, paf build, paf gen, paf check, paf tool, paf run, paf test, paf lint, paf format, and paf typecheck stop on a unit still pinned to one, or to a tag that is not a framework version, unless it is on a local framework through paf use <unit> local. paf use <unit> pinned always stops on one. paf status shows such a unit as a problem. Move it with paf pin <unit> <tag> to a framework 4 tag. A repo with any unit staying on framework 3 keeps paf 1.0.0 until every unit moves.
  • Breaking: A unit's framework folder is paf/ rather than lib/, and the swap folders are paf.paf-new/ and paf.paf-old/. The stamp inside it is .paf.json. Change the .gitignore lines for lib/ and lib.paf-*/, the workspaces entry, and every import and tsconfig path that names lib/. The framework's [4.0.0] entry lists the rest of that move.
  • Breaking: A face is now a folder holding pebble.appinfo.json at its own root, which is where framework 4 finds it, rather than one holding config/pebble.appinfo.json. It is still the unit itself for a face of its own, or a folder beside core/ in a family. Move each face's appinfo up a folder. paf sync, paf pin, paf use, and every command that readies a unit stop on one still in config/ and name the file to move, paf doctor reports it, and paf status shows ? for that unit's faces.
  • Breaking: paf sync copies the framework's src/ folder from the tag, leaving out every *.spec.ts, *.spec.c, and fixtures/ folder, and every plugin under src/plugins/ the unit's paf.config.json does not list. A plugin the unit lists that the tag does not have stops the sync with the tag's plugins named. Changing the plugins a unit lists fills paf/ again on the next sync, and the next build starts clean. paf use <unit> local copies the same set from the clone's working tree.
  • Breaking: Set a unit's workspaces to ["paf", "paf/plugins/*"]. paf sync, paf pin, paf use, and every command that readies a unit refuse a unit whose package.json leaves either out, or that has no package.json. The install now runs again whenever paf/package.json or any listed plugin's package.json changes, so listing or dropping a plugin installs its dependencies or removes them.
  • Breaking: paf gen <face> <kind> and paf gen <face> all now find the generators through the paf key in paf/package.json and in each listed plugin's package.json, and run each as node --disable-warning=MODULE_TYPELESS_PACKAGE_JSON <script> <face> from the unit. paf gen <face> all runs the framework's generators, then each listed plugin's in the order listed. A unit generator from gen runs straight after the one its after names, and one without after runs at the end. Each runs only when the face holds what its when names. all takes no arguments after it, and a failing generator's exit code is passed on.
  • paf build now runs the framework's tools/build.ts under Node, found through the build entry in paf/package.json's paf key, rather than bash lib/build.sh. A build still runs on Linux, WSL, or macOS and not on Windows itself, since pebble does. Under paf use <unit> local, an edit to the framework's waf/ folder now starts the next build clean, and an edit to its package.json no longer does.
  • Breaking: paf typecheck now runs tsc -p on every tsconfig.json and tsconfig.*.json in a unit outside paf/ and its swap folders, targets/, node_modules/, vendor/, coverage/, and any folder whose name starts with a dot other than .github/, rather than the unit's typecheck script, whose framework tool no longer ships. Give each of a unit's tsconfigs its own include, and drop the typecheck script. A root tsconfig.json that only points an editor at the others through references takes "files": [] in place of an include, so it checks nothing itself. A unit with no tsconfig fails the check.
  • Breaking: The sync action at this tag installs paf 2.0.0 and fills each unit's paf/. Load it as AKlitbo/pebble-app-framework-cli/.github/actions/sync@v2.0.0 in a face repo's workflows, since the action at @v1.0.0 installs paf 1.0.0, which cannot fill a framework 4 unit. Its node-version input has to fall inside the engines range in paf/package.json.
  • paf doctor now names a lib/ left in a unit from paf 1.0.0, a package.json whose workspaces npm cannot install the framework from, and a listed plugin paf/ does not hold.
  • paf sync now fills paf/ again, from its tag or its local clone, when a listed plugin is missing from it, and runs npm install again after a refill of a missing plugin or a missing paf/, so the packages npm had nested there come back.
  • paf status now calls a unit with a paf.paf-old left beside paf/ in need of a sync, since the next sync installs again.
  • paf build, paf gen, paf check, paf tool, paf lint, and paf format now refuse to run under a Node outside the engines range in paf/package.json, naming the range and the Node. The range is read once the sync is done, from the framework the unit builds on. That covers the unit's own generators too. Outside that range a tool can stop partway, and on a Node with no import.meta.main it stops before it starts. paf doctor shows such a unit as a problem.
  • Breaking: paf lint now runs the lint a listed plugin offers through a lint entry in its paf key, which is the framework's code-style plugin. List it under plugins, and drop the unit's eslint.config.ts, its lint scripts, and its ESLint packages. A unit that adds rules of its own keeps them in config/eslint.config.ts or in an eslint.config.ts at its root, and the plugin reads either. A unit that lists no such plugin keeps its own lint script, and one with neither fails. paf lint --fix passes the flag on.
  • paf sync, paf check, paf test, paf typecheck, paf lint, and paf format now stop when given more than one unit, since only the first was read and the rest looked done.
  • Breaking: paf test still runs the unit's test script, but framework 4 no longer ships the Vitest config it pointed at. Give the unit its own vitest.config.ts, with its packages in its devDependencies, and point the script at it.
  • paf gen <face> <kind> for a kind that only an unlisted plugin offers now names the plugin to list.
  • paf pin <unit> latest and the LATEST column of paf status only take a framework 4 tag.
  • paf use <unit> local checks the clone by its src/package.json, since the framework's root package.json is the repo it is developed in.
  • paf pin reads the changelog from src/CHANGELOG.md at the tag, and paf status and paf doctor read the toolchain from paf/toolchain.json.

Removed

  • Breaking: Removed reading the unit's gen:* npm scripts. paf gen no longer runs them, and a gen:<face> script no longer replaces the paf gen <face> all list. Drop them from the unit's package.json, and move a face's own steps, such as a colour table made from the Clay output, into gen in paf.config.json.
  • Removed reading the framework's package.json files list, which framework 4 does not have. What a unit gets is the framework's src/ folder, as the Changed entry above says.

v1.0.0

Choose a tag to compare

@AKlitbo AKlitbo released this 27 Sep 07:22

Warning

paf 1.0.0 is obsolete. Use paf 2.0.0 instead, which fills framework 4 units.

Initial release of the Pebble App Framework CLI.