doc: Readme updated & more logs added.

README.md

@@ -8,6 +8,10 @@ Supports the following databases: MySQL, Microsoft SQL Server, SQLite and Postgr
 
 `npx sql-ts-knex-generator -c ./config.json`
 
+It will create a folder and generate a file for each table containing CRUD (create, read, update, delete) functions based on DB schema.
+
+It respects nullable and required fields.
+
 ## Config file options
 
 [Config file options](https://saostad.github.io/sql-ts-knex-generator/interfaces/config.html)

docs/index.html

@@ -67,6 +67,8 @@ <h1>A simple command line tool to generate typescript CRUD operations</h1>
  <h2>How to use</h2>
  </a>
  <p><code>npx sql-ts-knex-generator -c ./config.json</code></p>
+ <p>It will create a folder and generate a file for each table containing CRUD (create, read, update, delete) functions based on DB schema.</p>
+ <p>It respects nullable and required fields.</p>
  <a href="#config-file-options" id="config-file-options" style="color: inherit; text-decoration: none;">
  <h2>Config file options</h2>
  </a>

docs/interfaces/config.html

@@ -196,7 +196,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> create<wbr>Index<wbr>
  <div class="tsd-signature tsd-kind-icon">create<wbr>Index<wbr>File<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></div>
  <aside class="tsd-sources">
  <ul>
- <li>Defined in <a href="https://github.com/saostad/sql-ts-knex-generator/blob/660547a/src/index.ts#L10">src/index.ts:10</a></li>
+ <li>Defined in <a href="https://github.com/saostad/sql-ts-knex-generator/blob/21f91b1/src/index.ts#L10">src/index.ts:10</a></li>
  </ul>
  </aside>
  <div class="tsd-comment tsd-typography">

package.json

@@ -1,6 +1,6 @@
 {
  "name": "sql-ts-knex-generator",
- "version": "1.5.1",
+ "version": "1.5.2",
  "main": "./dist/index.js",
  "description": "A simple command line tool to generate typescript CRUD operations from database schemas.",
  "bin": "./bin/sql-ts-knex-generator",
@@ -43,7 +43,9 @@
  "typescript",
  "interface",
  "generator",
- "CRUD"
+ "CRUD",
+ "sql",
+ "schema"
  ],
  "nodemonConfig": {
  "ignore": [

src/cli.ts

@@ -40,22 +40,29 @@ if (typeof config.template !== "string") {
 /** Create out directory if not exist */
 try {
  fs.mkdirSync(outDirPath);
+ console.log(`${outDirPath} folder has been created.`);
 } catch (error) {
  if (error.code !== "EEXIST") {
  console.log(error);
  }
 }
 
 (async () => {
+ console.log(`Connecting to db...`);
+
  const decoratedDatabase = await toObject(config);
 
  const { tables } = decoratedDatabase;
 
+ console.log(`Analyzing table's schema...`);
+
  const eachTable = tables.map((el) =>
  // TODO: add enums instead of ignoring it
  DatabaseTasks.stringifyDatabase({ tables: [el], enums: [] }, config),
  );
 
+ console.log(`Creating TS files...`);
+
  eachTable.forEach((el, index) => {
  const filePath = path.join(
  outDirPath,
@@ -74,5 +81,6 @@ export * from "./{{table.name}}";
  const filePath = path.join(outDirPath, `index.ts`);
  fs.writeFileSync(filePath, indexContent);
  }
- console.log(`files written in directory ${outDirPath}`);
+ console.log(`Files written in directory ${outDirPath}`);
+ console.log(`You can use "import {} form 'index.ts'"`);
 })();