Repository navigation
Releases
Releases · AKlitbo/pebble-app-framework-cli
v2.2.0
Added
- Added
--devto the usage and help ofpaf 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 topebble build, which refuses it. - Added units under
plugins/, besidewatchfaces/andwatchapps/, for a repo of plugin apps. A plugin app is a face whosepebble.appinfo.jsonsets"projectType": "plugin". paf syncs and builds it like any face, andpaf statusmarks it(plugin app).paf build all --devpasses over it with a line saying so, since it has no watch code for dev mode to change.
Changed
paf pinand 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 statusandpaf doctorshow such a unit as a problem.paf pin <unit> latestand the LATEST column ofpaf statusnow 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
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 intopaf/with its plugins and tools, so a later framework that keeps it needs no new paf.latestis now the newest such release, sopaf pin <unit> latestmoves a unit to framework 5.0.0. A framework 3 tag still needspaf 1.0.0.
v2.0.0
Added
- Added
paf format [unit] [--check], which runs the format a listed plugin offers through aformatentry in itspafkey, or the unit's ownformatscript. With thecode-styleplugin that is Prettier over a unit's CSS, JSON, and YAML, once the unit turns it on.--checkwrites 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 besidepaf test,paf lint, andpaf typecheck. - Added
paf tool <face> <name> [args], which runs a tool a listed plugin names undertoolsin itspafkey, such as thedevplugin'sclay-previewandtap-walk. Every argument after the name reaches the tool as typed,-hand--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
geninpaf.config.json:"gen": { "vibrant": { "script": "core/tools/vibrant/generate-vibrant.ts", "after": "clay" } }.scriptis a.tsfile relative to the unit, since paf runs every script with node.afternames the generator it runs after, and an optionalwhennames a file or folder the face has to hold forpaf gen <face> allto run it.
Changed
- Breaking: A unit's file is
paf.config.jsonrather thanpaf.json. It holdsframeworkandcommitas before, plusplugins, a map of the framework plugins the unit lists with each one's settings, andgen, a map of the unit's own generators. Rename the file by hand, and addpluginsfor each plugin the unit uses, such as"plugins": { "icons": { "sources": "../../vendor" }, "thumbnails": {} }. A repo with apaf.jsonleft in any unit stops every command until it is moved. - Breaking:
paf 2.0.0reads only the framework 4 layout.paf pinrefuses 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, andpaf typecheckstop on a unit still pinned to one, or to a tag that is not a framework version, unless it is on a local framework throughpaf use <unit> local.paf use <unit> pinnedalways stops on one.paf statusshows such a unit as a problem. Move it withpaf pin <unit> <tag>to a framework 4 tag. A repo with any unit staying on framework 3 keepspaf 1.0.0until every unit moves. - Breaking: A unit's framework folder is
paf/rather thanlib/, and the swap folders arepaf.paf-new/andpaf.paf-old/. The stamp inside it is.paf.json. Change the.gitignorelines forlib/andlib.paf-*/, theworkspacesentry, and every import and tsconfig path that nameslib/. The framework's[4.0.0]entry lists the rest of that move. - Breaking: A face is now a folder holding
pebble.appinfo.jsonat its own root, which is where framework 4 finds it, rather than one holdingconfig/pebble.appinfo.json. It is still the unit itself for a face of its own, or a folder besidecore/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 inconfig/and name the file to move,paf doctorreports it, andpaf statusshows?for that unit's faces. - Breaking:
paf synccopies the framework'ssrc/folder from the tag, leaving out every*.spec.ts,*.spec.c, andfixtures/folder, and every plugin undersrc/plugins/the unit'spaf.config.jsondoes 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 fillspaf/again on the next sync, and the next build starts clean.paf use <unit> localcopies the same set from the clone's working tree. - Breaking: Set a unit's
workspacesto["paf", "paf/plugins/*"].paf sync,paf pin,paf use, and every command that readies a unit refuse a unit whosepackage.jsonleaves either out, or that has nopackage.json. The install now runs again wheneverpaf/package.jsonor any listed plugin'spackage.jsonchanges, so listing or dropping a plugin installs its dependencies or removes them. - Breaking:
paf gen <face> <kind>andpaf gen <face> allnow find the generators through thepafkey inpaf/package.jsonand in each listed plugin'spackage.json, and run each asnode --disable-warning=MODULE_TYPELESS_PACKAGE_JSON <script> <face>from the unit.paf gen <face> allruns the framework's generators, then each listed plugin's in the order listed. A unit generator fromgenruns straight after the one itsafternames, and one withoutafterruns at the end. Each runs only when the face holds what itswhennames.alltakes no arguments after it, and a failing generator's exit code is passed on. paf buildnow runs the framework'stools/build.tsunder Node, found through thebuildentry inpaf/package.json'spafkey, rather thanbash lib/build.sh. A build still runs on Linux, WSL, or macOS and not on Windows itself, sincepebbledoes. Underpaf use <unit> local, an edit to the framework'swaf/folder now starts the next build clean, and an edit to itspackage.jsonno longer does.- Breaking:
paf typechecknow runstsc -pon everytsconfig.jsonandtsconfig.*.jsonin a unit outsidepaf/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'stypecheckscript, whose framework tool no longer ships. Give each of a unit's tsconfigs its owninclude, and drop thetypecheckscript. A roottsconfig.jsonthat only points an editor at the others throughreferencestakes"files": []in place of aninclude, so it checks nothing itself. A unit with no tsconfig fails the check. - Breaking: The sync action at this tag installs
paf 2.0.0and fills each unit'spaf/. Load it asAKlitbo/pebble-app-framework-cli/.github/actions/sync@v2.0.0in a face repo's workflows, since the action at@v1.0.0installspaf 1.0.0, which cannot fill a framework 4 unit. Itsnode-versioninput has to fall inside theenginesrange inpaf/package.json. paf doctornow names alib/left in a unit frompaf 1.0.0, apackage.jsonwhoseworkspacesnpm cannot install the framework from, and a listed pluginpaf/does not hold.paf syncnow fillspaf/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 missingpaf/, so the packages npm had nested there come back.paf statusnow calls a unit with apaf.paf-oldleft besidepaf/in need of a sync, since the next sync installs again.paf build,paf gen,paf check,paf tool,paf lint, andpaf formatnow refuse to run under a Node outside theenginesrange inpaf/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 noimport.meta.mainit stops before it starts.paf doctorshows such a unit as a problem.- Breaking:
paf lintnow runs the lint a listed plugin offers through alintentry in itspafkey, which is the framework'scode-styleplugin. List it underplugins, and drop the unit'seslint.config.ts, itslintscripts, and its ESLint packages. A unit that adds rules of its own keeps them inconfig/eslint.config.tsor in aneslint.config.tsat its root, and the plugin reads either. A unit that lists no such plugin keeps its ownlintscript, and one with neither fails.paf lint --fixpasses the flag on. paf sync,paf check,paf test,paf typecheck,paf lint, andpaf formatnow stop when given more than one unit, since only the first was read and the rest looked done.- Breaking:
paf teststill runs the unit'stestscript, but framework 4 no longer ships the Vitest config it pointed at. Give the unit its ownvitest.config.ts, with its packages in itsdevDependencies, 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> latestand the LATEST column ofpaf statusonly take a framework 4 tag.paf use <unit> localchecks the clone by itssrc/package.json, since the framework's rootpackage.jsonis the repo it is developed in.paf pinreads the changelog fromsrc/CHANGELOG.mdat the tag, andpaf statusandpaf doctorread the toolchain frompaf/toolchain.json.
Removed
- Breaking: Removed reading the unit's
gen:*npm scripts.paf genno longer runs them, and agen:<face>script no longer replaces thepaf gen <face> alllist. Drop them from the unit'spackage.json, and move a face's own steps, such as a colour table made from the Clay output, intogeninpaf.config.json. - Removed reading the framework's
package.jsonfileslist, which framework 4 does not have. What a unit gets is the framework'ssrc/folder, as the Changed entry above says.