feat: add optional --fix-content-type TDE-859

README.md

@@ -70,14 +70,14 @@ list s3://linz-imagery/sample --include ".*.tiff$"  --exclude "BG33.tiff$" --out
 
 ### `pretty-print`
 
-Format all JSON files within a directory using `prettier`.
+Format all JSON files within a directory using `prettier`. An optional flag `--fix-content-type` allows to set the content-type for s3 object with a value depending on the STAC object type.
 
 #### Example
 
 - Format and overwrite files:
 
 ```bash
-pretty-print source/
+pretty-print source/ [--fix-content-type]
 ```
 
 - Create a copy of the formatted file in another flatten directory (testing only - does not handle duplicate filenames):

src/commands/common.ts

@@ -74,3 +74,20 @@ export function parseSize(size: string): number {
   if (isNaN(fileSize)) throw new Error(`Failed to parse: ${size} as a file size`);
   return Math.round(fileSize);
 }
+
+/**
+ * Guess the content type of a STAC file
+ *
+ * - application/geo+json - A STAC Item
+ * - application/json - A STAC Catalog
+ * - application/json - A STAC Collection
+ *
+ * Assumes anything ending with '.json' is a stac item
+ * @see {@link https://github.com/radiantearth/stac-spec/blob/master/catalog-spec/catalog-spec.md#stac-media-types}
+ */
+export function guessStacContentType(path: string): string | undefined {
+  if (path.endsWith('collection.json')) return 'application/json';
+  if (path.endsWith('catalog.json')) return 'application/json';
+  if (path.endsWith('.json')) return 'application/geo+json';
+  return;
+}

src/commands/format/pretty.print.ts

@@ -1,13 +1,13 @@
 import { fsa } from '@chunkd/fs';
-import { command, option, optional, positional, string } from 'cmd-ts';
+import { boolean, command, flag, option, optional, positional, string } from 'cmd-ts';
 import { basename } from 'path';
 import prettier from 'prettier';
 
 import { CliInfo } from '../../cli.info.js';
 import { logger } from '../../log.js';
 import { getFiles } from '../../utils/chunk.js';
 import { DEFAULT_PRETTIER_FORMAT } from '../../utils/config.js';
-import { config, registerCli, verbose } from '../common.js';
+import { config, guessStacContentType, registerCli, verbose } from '../common.js';
 
 function isJson(x: string): boolean {
   const search = x.toLowerCase();
@@ -16,7 +16,7 @@ function isJson(x: string): boolean {
 
 export const commandPrettyPrint = command({
   name: 'pretty-print',
-  description: 'Pretty print JSON files',
+  description: 'Pretty-print JSON files',
   version: CliInfo.version,
   args: {
     config,
@@ -26,6 +26,13 @@ export const commandPrettyPrint = command({
       long: 'target',
       description: 'Use if files have to be saved somewhere else instead of overwriting the source (testing)',
     }),
+    fixContentType: flag({
+      type: boolean,
+      defaultValue: () => false,
+      long: 'fix-content-type',
+      description: 'Append a guessed content-type to the S3 object.',
+      defaultValueIsSerializable: true,
+    }),
     path: positional({ type: string, displayName: 'path', description: 'Path of the files to pretty print' }),
   },
 
@@ -45,7 +52,7 @@ export const commandPrettyPrint = command({
     if (jsonFiles[0]) await fsa.head(jsonFiles[0]);
 
     // format files
-    await Promise.all(jsonFiles.map((f: string) => formatFile(f, args.target)));
+    await Promise.all(jsonFiles.map((f: string) => formatFile(f, args.target, args.fixContentType)));
     logger.info({ fileCount: jsonFiles.length, duration: performance.now() - startTime }, 'PrettyPrint:Done');
   },
 });
@@ -55,16 +62,19 @@ export const commandPrettyPrint = command({
  *
  * @param path of the file to format
  * @param target where to save the output. If not specified, overwrite the original file.
+ * @param fixContentType if true will set the `contentType` with a guessed value. @see guessStacContentType
  */
-export async function formatFile(path: string, target = ''): Promise<void> {
+export async function formatFile(path: string, target = '', fixContentType: boolean = false): Promise<void> {
   logger.debug({ file: path }, 'PrettyPrint:RunPrettier');
   const prettyPrinted = await prettyPrint(JSON.stringify(await fsa.readJson(path)), DEFAULT_PRETTIER_FORMAT);
   if (target) {
     // FIXME: can be duplicate files
     path = fsa.join(target, basename(path));
   }
+  let meta = {};
+  if (fixContentType) meta = { contentType: guessStacContentType(path) };
 
-  fsa.write(path, Buffer.from(prettyPrinted));
+  fsa.write(path, Buffer.from(prettyPrinted), meta);
 }
 
 /**

src/commands/stac-sync/stac.sync.ts

@@ -5,7 +5,7 @@ import { createHash } from 'crypto';
 
 import { CliInfo } from '../../cli.info.js';
 import { logger } from '../../log.js';
-import { config, registerCli, verbose } from '../common.js';
+import { config, guessStacContentType, registerCli, verbose } from '../common.js';
 
 const S3Path: Type<string, URL> = {
   async from(str) {
@@ -85,20 +85,3 @@ export async function uploadFileToS3(sourceFileInfo: FileInfo, path: URL): Promi
   logger.debug({ path: path.href }, 'StacSync:FileUploaded');
   return true;
 }
-
-/**
- * Guess the content type of a STAC file
- *
- * - application/geo+json - A STAC Item
- * - application/json - A STAC Catalog
- * - application/json - A STAC Collection
- *
- * Assumes anything ending with '.json' is a stac item
- * @see {@link https://github.com/radiantearth/stac-spec/blob/master/catalog-spec/catalog-spec.md#stac-media-types}
- */
-function guessStacContentType(path: string): string | undefined {
-  if (path.endsWith('collection.json')) return 'application/json';
-  if (path.endsWith('catalog.json')) return 'application/json';
-  if (path.endsWith('.json')) return 'application/geo+json';
-  return;
-}