@tideworthy/tidysites 0.1.2 → 0.1.4

package/README.md

@@ -22,12 +22,13 @@ nothing else; it lives in `.tidysites/key`, which is kept out of git.
 | `tidysites status` | what changed here since the pull |
 | `tidysites validate` | every file against the content model, with the file and the field in each message |
 | `tidysites push [--prune] [--force] [--dry] [--only pages]` | validate, then write the created and updated entries back (with `--prune`, delete the entries whose files are gone), then pull |
-| `tidysites shot <path or url> [--mobile] [--desktop] [--first-screen] [--live]` | a screenshot of a page of the preview site, the live site, or any address, saved under `.tidysites/shots/` |
+| `tidysites shot <path or url> [--mobile] [--tablet] [--desktop] [--wide] [--all] [--first-screen] [--live]` | a screenshot of a page of the preview site, the live site, or any address, saved under `.tidysites/shots/`; none of the width flags means desktop and mobile; a port compares all four |
 | `tidysites pages` | every address the website renders |
 | `tidysites page <path> [--html]` | the rendered page, section by section, with the key each section carries |
 | `tidysites schema [type or collection]` | the section types and layouts, or one type's or collection's fields |
 | `tidysites gallery [type]` | a screenshot of every section type and layout in this website's theme, or the first screen of one type |
 | `tidysites fetch <url> [--out dir]` | a page of the site being ported: cleaned HTML, its outline (headings, navigation, images, phones, fonts, colours) and its stylesheets |
+| `tidysites rm <collection>/<slug> ...` | delete entry files with their sidecars (`services/*` for every entry of a collection); `push --prune` then removes them from the website |
 | `tidysites publish --yes` | the live site becomes a copy of the preview site |
 
 A section keeps its type with its key: to replace an intro with a row, give the row its own `_key`
@@ -50,7 +51,7 @@ menus/<name>.json             a menu as a tree: { "label", "items": [{ "label",
 
 A new entry is a new `<collection>/<slug>.json` with at least `"data"`; the
 slug is the file name, the status is `published` unless the file says
-`draft`. Delete a file and `push --prune` removes the entry. A field taken
+`draft`. Delete a file (`tidysites rm services/old-one`, or `services/*` for all) and `push --prune` removes the entry. A field taken
 out of a file is cleared on the website at the next push. `id` and
 `updated_at` are the website's; leave them as pulled. A pull never overwrites
 a file you changed and have not pushed; it keeps the file and the difference
@@ -82,4 +83,4 @@ names its own in `header_row`.
 3. `frame/frame.json` for the top bar, the call bar, the footer headings, the wording; `menus/primary.json` and `menus/footer.json` for the menus (an item with `children` is a dropdown).
 4. Pages as sections: `pages/<slug>.json`, each a list in `data.sections`. Columns is the section for a band with no record behind it.
 5. The look: brand colours and fonts on the Business record, `business/business.css` for what the tokens cannot say. The theme's own rules are written as `.ts.ts-accent` and `.ts.ts-ink .ts-prose a`, so a rule of yours needs the same weight (`.ts.ts-accent …`) to win.
-6. `tidysites validate`, `tidysites push`, `tidysites shot /` and `tidysites shot / --mobile`, and look.
+6. `tidysites validate`, `tidysites push`, `tidysites shot / --all`, and look at every width: a design often shows a different header above 1440px.

package/bin/tidysites.mjs

@@ -7,12 +7,13 @@
  *   status                                    what changed here since the pull
  *   validate                                  check the files against the content model
  *   push [--prune] [--force] [--dry]          write the changes back, then pull
- *   shot <path|url> [--mobile|--desktop] [--first-screen]   screenshot to .tidysites/shots
+ *   shot <path|url> [--mobile] [--tablet] [--desktop] [--wide] [--all] [--first-screen]   screenshot to .tidysites/shots (none = desktop and mobile)
  *   pages                                     every address the website renders
  *   page <path> [--html]                      the rendered page, section by section
  *   schema [name]                             section types and layouts, or one type's or collection's fields
  *   gallery [type]                            screenshot of every section type in this theme, or the first screen of one type
  *   fetch <url> [--out dir]                   a page of the site being ported: cleaned HTML and its outline
+ *   rm <collection>/<slug> ...                 delete entry files (globs allowed: services/*); push --prune then removes them from the website
  *   publish --yes                             the live site becomes a copy of the preview site
  *
  * The site is the remote: pull, edit, push. A push that would overwrite an
@@ -357,7 +358,9 @@ async function push(ctx) {
 
 async function shot(ctx, target = positional[0] ?? '/', opts = {}) {
 	const isUrl = /^https?:\/\//.test(target);
-	const view = flags.mobile ? 'mobile' : flags.desktop ? 'desktop' : (opts.view ?? 'both');
+	// --desktop, --mobile, --tablet, --wide, any of them together; --all for every width; none = desktop and mobile.
+	const picked = ['desktop', 'mobile', 'tablet', 'wide'].filter((v) => flags[v]);
+	const view = flags.all ? 'all' : picked.length ? picked.join(',') : (opts.view ?? 'both');
 	const args = { site_id: ctx.cfg.site, view, full_page: !(flags['first-screen'] || opts.firstScreen), ...(isUrl ? { url: target } : { path: target, site: flags.live ? 'live' : 'preview' }) };
 	const { json, images } = await tool(ctx.cfg, 'screenshot_website', args);
 	const outDir = join(ctx.dir, META, 'shots');
@@ -366,7 +369,7 @@ async function shot(ctx, target = positional[0] ?? '/', opts = {}) {
 	const base = (opts.name ?? (isUrl ? new URL(target).hostname + new URL(target).pathname : target)).replace(/[^a-z0-9]+/gi, '-').replace(/^-|-$/g, '') || 'home';
 	const named = Array.isArray(json?.captures) ? json.captures : [];
 	images.forEach((img, i) => {
-		const v = named[i]?.view ?? (view === 'both' ? ['desktop', 'mobile'][i] : view);
+		const v = named[i]?.view ?? (view === 'both' ? ['desktop', 'mobile'][i] : view === 'all' ? ['desktop', 'mobile', 'tablet', 'wide'][i] : view.split(',')[i] ?? view);
 		const p = join(outDir, `${base}-${v}-${stamp}.${img.mimeType.includes('png') ? 'png' : 'jpg'}`);
 		writeFileSync(p, Buffer.from(img.base64, 'base64'));
 		say(relative(process.cwd(), p));
@@ -463,6 +466,32 @@ async function fetchCmd(ctx) {
 	say(`Saved to ${relative(process.cwd(), outDir)}/: ${base}.html (cleaned), ${base}.raw.html, ${base}.outline.json${cssTexts.length ? `, ${cssTexts.length} stylesheet${cssTexts.length === 1 ? '' : 's'}` : ''}`);
 }
 
+/**
+ * Delete entry files inside the folder, with their sidecars, so nobody has to reach for the shell's rm (which a
+ * harness may stop to ask about). Takes collection/slug paths; a trailing * takes every entry of the collection.
+ */
+function rmCmd({ dir }) {
+	if (!positional.length) fail('Usage: tidysites rm <collection>/<slug> [...]   (services/* for every entry of a collection)');
+	let removed = 0;
+	for (const arg of positional) {
+		const m = /^([a-z][a-z0-9_]*)\/(\*|[A-Za-z0-9][A-Za-z0-9_-]*)(?:\.json)?$/.exec(arg.replace(/^\.\//, ''));
+		if (!m) fail(`${arg}: write collection/slug or collection/*`);
+		const [, collection, slug] = m;
+		const colDir = join(dir, collection);
+		if (!existsSync(colDir)) { say(`${collection}/: no such collection folder`); continue; }
+		const slugs = slug === '*' ? readdirSync(colDir).filter((f) => f.endsWith('.json')).map((f) => f.slice(0, -5)) : [slug];
+		for (const sl of slugs) {
+			let hit = false;
+			for (const ext of ['json', ...Object.keys(SIDECARS[collection] ?? SIDECARS.default)]) {
+				const f = join(colDir, `${sl}.${ext}`);
+				if (existsSync(f)) { rmSync(f); hit = true; }
+			}
+			if (hit) { removed++; say(`- ${collection}/${sl}`); } else say(`${collection}/${sl}: no such entry file`);
+		}
+	}
+	say(`${removed} entr${removed === 1 ? 'y' : 'ies'} removed from the folder; \`tidysites push --prune\` removes them from the website.`);
+}
+
 async function publish(ctx) {
 	if (!flags.yes) fail('Publishing makes the live site a copy of the preview site. Look at it first (`tidysites shot /`), then run `tidysites publish --yes`.');
 	const { json, text } = await tool(ctx.cfg, 'publish_website', { site_id: ctx.cfg.site });
@@ -522,6 +551,8 @@ async function main() {
 			return schema(config());
 		case 'fetch':
 			return fetchCmd(config(false));
+		case 'rm':
+			return rmCmd(config());
 		case 'publish':
 			return publish(config());
 		case 'help':

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tideworthy/tidysites",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Pull a Tidysites website to files, edit, validate against its content model, push it back, screenshot the result.",
   "type": "module",
   "bin": {