@tinacms/cli 0.59.0 → 0.60.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # tinacms-cli
 
+## 0.60.0
+
+### Minor Changes
+
+- 35884152b: Adds and audit command that checks files for errors.
+
+### Patch Changes
+
+- 083aa8ec6: Rebuild database every save while in local mode
+- Updated dependencies [b66aefde1]
+- Updated dependencies [35884152b]
+- Updated dependencies [4948beec6]
+  - @tinacms/graphql@0.59.4
+
 ## 0.59.0
 
 ### Minor Changes

package/README.md

@@ -19,20 +19,23 @@ yarn add --dev @tinacms/cli
 ## Usage
 
 ```
-Usage:  command [options]
+Usage: @tinacms/cli command [options]
 
 Options:
-  -V, --version           output the version number
-  -h, --help              display help for command
+  -V, --version             output the version number
+  -h, --help                display help for command
 
 Commands:
-  server:start [options]  Start Filesystem Graphql Server
-  schema:compile          Compile schema into static files for the server
-  schema:types            Generate a GraphQL query for your site's schema, (and
-                          optionally Typescript types)
-  help [command]          display help for command
+  server:start [options]    Start Filesystem Graphql Server
+  schema:compile [options]  Compile schema into static files for the server
+  schema:types [options]    Generate a GraphQL query for your site's schema, (and optionally Typescript types)
+  init [options]            Add Tina Cloud to an existing project
+  audit [options]           Audit your schema and the files to check for errors
+  help [command]            display help for command
 ```
 
+[See our docs](https://tina.io/docs/cli-overview/) for more information about the commands.
+
 ## Getting started
 
 The simplest way to get started is to add a `.tina/schema.ts` file
@@ -228,3 +231,8 @@ getPostsDocument(relativePath: "voteForPedro.md") {
 To learn how to work with this data on a Tina-enabled site, check out the [client documentation](https://tina.io/docs/tina-cloud/client/)
 
 > This API is currently somewhat limited. Specifically there's no support for filtering and sorting "list" queries. We have plans to tackle that in upcoming cycles
+
+
+## API Docs
+
+See [our doc page](https://tina.io/docs/cli-overview/) for specific API docs

package/dist/cmds/audit/audit.d.ts

@@ -0,0 +1,31 @@
+/**
+Copyright 2021 Forestry.io Holdings, Inc.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+    http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+import type { Database, TinaCloudCollection } from '@tinacms/graphql';
+declare type AuditArgs = {
+    collection: TinaCloudCollection;
+    database: Database;
+    rootPath: string;
+    useDefaultValues: boolean;
+};
+export declare const auditCollection: (args: AuditArgs) => Promise<boolean>;
+export declare const auditDocuments: (args: AuditArgs) => Promise<boolean>;
+export declare const transformDocumentIntoMutationRequestPayload: (document: {
+    [key: string]: unknown;
+    _collection: string;
+    __typename?: string;
+    _template: string;
+}, instructions: {
+    includeCollection?: boolean;
+    includeTemplate?: boolean;
+}, defaults?: any) => any;
+export {};

package/dist/cmds/audit/index.d.ts

@@ -0,0 +1,14 @@
+/**
+Copyright 2021 Forestry.io Holdings, Inc.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+    http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+export declare const audit: (ctx: any, next: () => void, options: any) => Promise<void>;
+export declare const printFinalMessage: (ctx: any, next: () => void, _options: any) => Promise<void>;

package/dist/cmds/baseCmds.d.ts

@@ -15,4 +15,5 @@ export declare const CMD_GEN_TYPES = "schema:types";
 export declare const CMD_START_SERVER = "server:start";
 export declare const CMD_COMPILE_MODELS = "schema:compile";
 export declare const INIT = "init";
+export declare const AUDIT = "audit";
 export declare const baseCmds: Command[];

package/dist/index.js

@@ -135,11 +135,11 @@ logger.level = "info";
 // pnp:/Users/jeffsee/code/tinacms/packages/@tinacms/cli/src/cmds/query-gen/attachSchema.ts
 async function attachSchema(ctx, next, options) {
   logger.info(logText("Building schema..."));
-  const rootPath = process.cwd();
-  const bridge = new import_datalayer.FilesystemBridge(rootPath);
-  const store = new import_datalayer.FilesystemStore({ rootPath });
+  const rootPath2 = process.cwd();
+  const bridge = new import_datalayer.FilesystemBridge(rootPath2);
+  const store = new import_datalayer.FilesystemStore({ rootPath: rootPath2 });
   const database = await (0, import_graphql.createDatabase)({ store, bridge });
-  const schema = await (0, import_graphql.buildSchema)(rootPath, database);
+  const schema = await (0, import_graphql.buildSchema)(rootPath2, database);
   ctx.schema = schema;
   next();
 }
@@ -346,7 +346,7 @@ async function genTypes({ schema }, next, options) {
 // DO NOT MODIFY THIS FILE. This file is automatically generated by Tina
 ${typescriptTypes}
 `);
-  logger.info(`Typescript types => ${successText(typesPath)}`);
+  logger.info(`Typescript types => ${logText(typesPath)}`);
   const schemaString = await (0, import_graphql6.printSchema)(schema);
   const schemaPath = process.cwd() + "/.tina/__generated__/schema.gql";
   await import_fs_extra.default.outputFile(schemaPath, `# DO NOT MODIFY THIS FILE. This file is automatically generated by Tina
@@ -356,7 +356,7 @@ schema {
   mutation: Mutation
 }
   `);
-  logger.info(`GraphQL types ====> ${successText(schemaPath)}`);
+  logger.info(`GraphQL types ====> ${logText(schemaPath)}`);
   next();
 }
 
@@ -467,12 +467,12 @@ var defineSchema = (config) => {
 var import_chokidar = __toModule(require("chokidar"));
 var gqlPackageFile = require.resolve("@tinacms/graphql");
 async function startServer(_ctx, _next, { port = 4001, command, noWatch, experimentalData, noSDK }) {
-  const rootPath = process.cwd();
+  const rootPath2 = process.cwd();
   if (!process.env.CI && !noWatch) {
     await resetGeneratedFolder();
   }
-  const bridge = new import_datalayer2.FilesystemBridge(rootPath);
-  const store = experimentalData ? new import_datalayer2.LevelStore(rootPath) : new import_datalayer2.FilesystemStore({ rootPath });
+  const bridge = new import_datalayer2.FilesystemBridge(rootPath2);
+  const store = experimentalData ? new import_datalayer2.LevelStore(rootPath2) : new import_datalayer2.FilesystemStore({ rootPath: rootPath2 });
   const shouldBuild = bridge.supportsBuilding();
   const database = await (0, import_graphql7.createDatabase)({ store, bridge });
   const startSubprocess = () => {
@@ -499,8 +499,8 @@ stack: ${code.stack || "No stack was provided"}`);
   };
   let ready = false;
   if (!noWatch && !process.env.CI) {
-    import_chokidar.default.watch([`${rootPath}/**/*.{ts,gql,graphql}`], {
-      ignored: `${import_path3.default.resolve(rootPath)}/.tina/__generated__/**/*`
+    import_chokidar.default.watch([`${rootPath2}/**/*.{ts,gql,graphql}`], {
+      ignored: `${import_path3.default.resolve(rootPath2)}/.tina/__generated__/**/*`
     }).on("ready", async () => {
       console.log("Generating Tina config");
       try {
@@ -529,8 +529,14 @@ stack: ${code.stack || "No stack was provided"}`);
     });
   }
   const build = async (noSDK2) => {
+    if (!process.env.CI && !noWatch) {
+      await resetGeneratedFolder();
+    }
+    const bridge2 = new import_datalayer2.FilesystemBridge(rootPath2);
+    const store2 = experimentalData ? new import_datalayer2.LevelStore(rootPath2) : new import_datalayer2.FilesystemStore({ rootPath: rootPath2 });
+    const database2 = await (0, import_graphql7.createDatabase)({ store: store2, bridge: bridge2 });
     await compile(null, null);
-    const schema = await (0, import_graphql7.buildSchema)(rootPath, database);
+    const schema = await (0, import_graphql7.buildSchema)(rootPath2, database2);
     await genTypes({ schema }, () => {
     }, { noSDK: noSDK2 });
   };
@@ -933,12 +939,12 @@ export default App
 var import_chalk2 = __toModule(require("chalk"));
 function execShellCommand(cmd) {
   const exec = require("child_process").exec;
-  return new Promise((resolve, reject) => {
+  return new Promise((resolve2, reject) => {
     exec(cmd, (error, stdout, stderr) => {
       if (error) {
         console.warn(error);
       }
-      resolve(stdout ? stdout : stderr);
+      resolve2(stdout ? stdout : stderr);
     });
   });
 }
@@ -1040,11 +1046,252 @@ Enjoy Tina \u{1F999} !
   next();
 }
 
+// pnp:/Users/jeffsee/code/tinacms/packages/@tinacms/cli/src/cmds/audit/index.ts
+var import_graphql10 = __toModule(require("@tinacms/graphql"));
+var import_datalayer3 = __toModule(require("@tinacms/datalayer"));
+
+// pnp:/Users/jeffsee/code/tinacms/packages/@tinacms/cli/src/cmds/audit/audit.ts
+var import_graphql8 = __toModule(require("@tinacms/graphql"));
+var import_path5 = __toModule(require("path"));
+var import_graphql9 = __toModule(require("@tinacms/graphql"));
+var import_chalk3 = __toModule(require("chalk"));
+var auditCollection = async (args) => {
+  let warning = false;
+  const { collection, database, rootPath: rootPath2 } = args;
+  logger.info(`Checking collection ${collection.name}`);
+  const query = `query {
+        getCollection(collection: "${collection.name}") {
+          format
+          documents {
+            edges {
+              node {
+                ...on Document {
+                  sys {
+                    extension
+                    path
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+      `;
+  const result = await (0, import_graphql8.resolve)({
+    database,
+    query,
+    variables: {}
+  });
+  const format = result.data.getCollection.format;
+  const docs = result.data.getCollection.documents.edges;
+  docs.forEach((x) => {
+    const node = x.node;
+    if (node.sys.extension.replace(".", "") !== format) {
+      warning = true;
+      logger.warn(import_chalk3.default.yellowBright(`WARNING: there is a file with extension \`${node.sys.extension}\` but in your schema it is defined to be \`.${format}\`
+
+location: ${import_path5.default.join(rootPath2, node.sys.path)}`));
+    }
+  });
+  return warning;
+};
+var auditDocuments = async (args) => {
+  const { collection, database, rootPath: rootPath2, useDefaultValues } = args;
+  const query = `query {
+        getCollection(collection: "${collection.name}") {
+          format
+          slug
+          documents {
+            edges {
+              node {
+                ...on Document {
+                  sys {
+                    extension
+                    path
+                    relativePath
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+      `;
+  const result = await (0, import_graphql8.resolve)({
+    database,
+    query,
+    variables: {}
+  });
+  let error = false;
+  const documents = result.data.getCollection.documents.edges;
+  for (let i = 0; i < documents.length; i++) {
+    const node = documents[i].node;
+    const fullPath = import_path5.default.join(rootPath2, node.sys.path);
+    logger.info(`Checking document: ${fullPath}`);
+    const documentQuery = `query {
+        getDocument(collection: "${collection.name}", relativePath: "${node.sys.relativePath}") {
+          __typename
+          ...on Document {
+            values
+          }
+        }
+      }`;
+    const docResult = await (0, import_graphql8.resolve)({
+      database,
+      query: documentQuery,
+      variables: {}
+    });
+    const topLevelDefaults = {};
+    if (useDefaultValues && typeof collection.fields !== "string") {
+      collection.fields.filter((x) => !x.list).forEach((x) => {
+        const value = x.ui;
+        if (typeof value !== "undefined") {
+          topLevelDefaults[x.name] = value.defaultValue;
+        }
+      });
+    }
+    const params = transformDocumentIntoMutationRequestPayload(docResult.data.getDocument.values, {
+      includeCollection: true,
+      includeTemplate: typeof collection.templates !== "undefined"
+    }, topLevelDefaults);
+    const mutation = `mutation($collection: String!, $relativePath: String!, $params: DocumentMutation!) {
+        updateDocument(
+          collection: $collection,
+          relativePath: $relativePath,
+          params: $params
+        ){__typename}
+      }`;
+    const mutationRes = await (0, import_graphql8.resolve)({
+      database,
+      query: mutation,
+      variables: {
+        params,
+        collection: collection.name,
+        relativePath: node.sys.relativePath
+      },
+      silenceErrors: true
+    });
+    if (mutationRes.errors) {
+      mutationRes.errors.forEach((err) => {
+        error = true;
+        logger.error(import_chalk3.default.red(err.message));
+      });
+    }
+  }
+  return error;
+};
+var transformDocumentIntoMutationRequestPayload = (document, instructions, defaults) => {
+  const { _collection, __typename, _template, ...rest } = document;
+  const params = transformParams(rest);
+  const paramsWithTemplate = instructions.includeTemplate ? { [_template]: params } : params;
+  return instructions.includeCollection ? { [_collection]: { ...defaults, ...filterObject(paramsWithTemplate) } } : { ...defaults, ...filterObject(paramsWithTemplate) };
+};
+var transformParams = (data) => {
+  if (["string", "number", "boolean"].includes(typeof data)) {
+    return data;
+  }
+  if (Array.isArray(data)) {
+    return data.map((item) => transformParams(item));
+  }
+  try {
+    (0, import_graphql9.assertShape)(data, (yup) => yup.object({ _template: yup.string().required() }));
+    const { _template, __typename, ...rest } = data;
+    const nested = transformParams(rest);
+    return { [_template]: nested };
+  } catch (e) {
+    if (e.message === "Failed to assertShape - _template is a required field") {
+      if (!data) {
+        return void 0;
+        return [];
+      }
+      const accum = {};
+      Object.entries(data).map(([keyName, value]) => {
+        accum[keyName] = transformParams(value);
+      });
+      return accum;
+    } else {
+      if (!data) {
+        return void 0;
+        return [];
+      }
+      throw e;
+    }
+  }
+};
+function filterObject(obj) {
+  const ret = {};
+  Object.keys(obj).filter((key) => obj[key] !== void 0).forEach((key) => ret[key] = obj[key]);
+  return ret;
+}
+
+// pnp:/Users/jeffsee/code/tinacms/packages/@tinacms/cli/src/cmds/audit/index.ts
+var import_chalk4 = __toModule(require("chalk"));
+var import_prompts2 = __toModule(require("prompts"));
+var rootPath = process.cwd();
+var audit = async (ctx, next, options) => {
+  if (options.clean) {
+    logger.info(`You are using the \`--clean\` option. This will modify your content as if a user is submitting a form. Before running this you should have a ${import_chalk4.default.bold("clean git tree")} so unwanted changes can be undone.
+
+`);
+    const res = await (0, import_prompts2.default)({
+      name: "useClean",
+      type: "confirm",
+      message: `Do you want to continue?`
+    });
+    if (!res.useClean) {
+      logger.warn(import_chalk4.default.yellowBright("\u26A0\uFE0F Audit not complete"));
+      process.exit(0);
+    }
+  }
+  if (options.useDefaultValues && !options.clean) {
+    logger.warn(import_chalk4.default.yellowBright("WARNING: using the `--useDefaultValues` without the `--clean` flag has no effect. Please re-run audit and add the `--clean` flag"));
+  }
+  const bridge = options.clean ? new import_datalayer3.FilesystemBridge(rootPath) : new import_datalayer3.AuditFileSystemBridge(rootPath);
+  const store = options.clean ? new import_datalayer3.FilesystemStore({ rootPath }) : new import_datalayer3.AuditFilesystemStore({ rootPath });
+  const database = await (0, import_graphql10.createDatabase)({ store, bridge });
+  const schema = await database.getSchema();
+  const collections = schema.getCollections();
+  let warning = false;
+  let error = false;
+  for (let i = 0; i < collections.length; i++) {
+    const collection = collections[i];
+    const returnWarning = await auditCollection({
+      collection,
+      database,
+      rootPath,
+      useDefaultValues: options.useDefaultValues
+    });
+    const returnError = await auditDocuments({
+      collection,
+      database,
+      rootPath,
+      useDefaultValues: options.useDefaultValues
+    });
+    warning = warning || returnWarning;
+    error = error || returnError;
+  }
+  ctx.warning = warning;
+  ctx.error = error;
+  next();
+};
+var printFinalMessage = async (ctx, next, _options) => {
+  if (ctx.error) {
+    logger.error(import_chalk4.default.redBright(`\u203C\uFE0F Audit ${import_chalk4.default.bold("failed")} with errors`));
+  } else if (ctx.warning) {
+    logger.warn(import_chalk4.default.yellowBright("\u26A0\uFE0F Audit passed with warnings"));
+  } else {
+    logger.info(import_chalk4.default.greenBright("\u2705 Audit passed"));
+  }
+  next();
+};
+
 // pnp:/Users/jeffsee/code/tinacms/packages/@tinacms/cli/src/cmds/baseCmds.ts
+var import_chalk5 = __toModule(require("chalk"));
 var CMD_GEN_TYPES = "schema:types";
 var CMD_START_SERVER = "server:start";
 var CMD_COMPILE_MODELS = "schema:compile";
 var INIT = "init";
+var AUDIT = "audit";
 var startServerPortOption = {
   name: "--port <port>",
   description: "Specify a port to run the server on. (default 4001)"
@@ -1065,6 +1312,14 @@ var noSDKCodegenOption = {
   name: "--noSDK",
   description: "Don't generate the generated client SDK"
 };
+var cleanOption = {
+  name: "--clean",
+  description: "Submit gql mutation to all files to git rid of any data that is not defined in the `schema.ts`"
+};
+var useDefaultValuesOption = {
+  name: "--useDefaultValues",
+  description: "Adds default values to the graphQL mutation so that default values can be filled into existing documents (useful for adding a field with `required: true`)"
+};
 var baseCmds = [
   {
     command: CMD_START_SERVER,
@@ -1106,6 +1361,30 @@ var baseCmds = [
       tinaSetup,
       successMessage
     ], options)
+  },
+  {
+    options: [cleanOption, useDefaultValuesOption],
+    command: AUDIT,
+    description: "Audit your schema and the files to check for errors",
+    action: (options) => chain([
+      async (_ctx, next) => {
+        logger.level = "error";
+        next();
+      },
+      async (_ctx, next) => {
+        await compile(_ctx, next);
+        next();
+      },
+      attachSchema,
+      genTypes,
+      async (_ctx, next) => {
+        logger.level = "info";
+        logger.info(import_chalk5.default.hex("#eb6337").bgWhite("Welcome to tina audit \u{1F999}"));
+        next();
+      },
+      audit,
+      printFinalMessage
+    ], options)
   }
 ];
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tinacms/cli",
-  "version": "0.59.0",
+  "version": "0.60.0",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "files": [
@@ -57,7 +57,7 @@
     "@graphql-tools/graphql-file-loader": "^7.2.0",
     "@graphql-tools/load": "^7.3.2",
     "@tinacms/datalayer": "0.0.1",
-    "@tinacms/graphql": "0.59.3",
+    "@tinacms/graphql": "0.59.4",
     "ajv": "^6.12.3",
     "altair-express-middleware": "4.0.6",
     "auto-bind": "^4.0.0",