format and updated readme

Author: dougg0k

packages/ferric/README.md

@@ -2,6 +2,20 @@
 
 A wrapper around Cargo making it easier to produce prebuilt binaries targeting iOS and Android matching the [the prebuilt binary specification](https://github.com/callstackincubator/react-native-node-api/blob/main/docs/PREBUILDS.md) as well as [napi.rs](https://napi.rs/) to generate bindings from annotated Rust code.
 
+## Install the project
+
+`npm install --save-dev ferric-cli`
+
+## Add scripts
+
+```json
+"scripts": {
+  "gen:rs": "ferric init lib_name",
+   "build": "ferric build --cwd lib_name",
+   "build:release": "npm run build -- --configuration release",
+},
+```
+
 ### Project Structure
 
 After generating the project, a folder would be created with the following file structure for the lib.

packages/ferric/src/init.ts

@@ -6,70 +6,70 @@ import { oraPromise } from "ora";
 import { prettyPath } from "react-native-node-api";
 
 export const initCommand = new Command("init")
-	.description("Generate the project scaffold")
-	.argument("<name>", "Type the project name")
-	.action(async (str) => {
-		const projectName = str && str.length > 0 ? str : "ferric_project";
-		const generatePath = path.join(process.cwd(), projectName);
-		await oraPromise(
-			generateProject({ outputPath: generatePath, projectName }),
-			{
-				text: "Generating project",
-				successText: `Generated project ${prettyPath(generatePath)}`,
-				failText: (error) => `Failed to generate the project: ${error.message}`,
-			},
-		);
-	});
+  .description("Generate the project scaffold")
+  .argument("<name>", "Type the project name")
+  .action(async (str) => {
+    const projectName = str && str.length > 0 ? str : "ferric_project";
+    const generatePath = path.join(process.cwd(), projectName);
+    await oraPromise(
+      generateProject({ outputPath: generatePath, projectName }),
+      {
+        text: "Generating project",
+        successText: `Generated project ${prettyPath(generatePath)}`,
+        failText: (error) => `Failed to generate the project: ${error.message}`,
+      },
+    );
+  });
 
 async function replaceStrInFile(
-	filePath: string,
-	oldStr: string,
-	newStr: string,
+  filePath: string,
+  oldStr: string,
+  newStr: string,
 ) {
-	const content = await fsPromise.readFile(filePath, "utf8");
-	const updatedContent = content.replaceAll(oldStr, newStr);
-	await fsPromise.writeFile(filePath, updatedContent, "utf8");
+  const content = await fsPromise.readFile(filePath, "utf8");
+  const updatedContent = content.replaceAll(oldStr, newStr);
+  await fsPromise.writeFile(filePath, updatedContent, "utf8");
 }
 
 function createFolder(path: string) {
-	if (!fs.existsSync(path)) {
-		fs.mkdirSync(path);
-	}
+  if (!fs.existsSync(path)) {
+    fs.mkdirSync(path);
+  }
 }
 
 async function copyAllTemplateFiles(outputFilePath: string) {
-	const templateDir = path.join(import.meta.dirname, "templates");
-	await fsPromise.cp(templateDir, outputFilePath, {
-		recursive: true,
-	});
-	await fsPromise.rename(
-		`${outputFilePath}/lib.rs`,
-		`${outputFilePath}/src/lib.rs`,
-	);
-	await fsPromise.rename(
-		`${outputFilePath}/gitignore`,
-		`${outputFilePath}/.gitignore`,
-	);
+  const templateDir = path.join(import.meta.dirname, "templates");
+  await fsPromise.cp(templateDir, outputFilePath, {
+    recursive: true,
+  });
+  await fsPromise.rename(
+    `${outputFilePath}/lib.rs`,
+    `${outputFilePath}/src/lib.rs`,
+  );
+  await fsPromise.rename(
+    `${outputFilePath}/gitignore`,
+    `${outputFilePath}/.gitignore`,
+  );
 }
 
 async function generateProject({
-	outputPath,
-	projectName,
+  outputPath,
+  projectName,
 }: {
-	outputPath: string;
-	projectName: string;
+  outputPath: string;
+  projectName: string;
 }) {
-	createFolder(outputPath);
-	createFolder(`${outputPath}/src`);
-	await copyAllTemplateFiles(outputPath);
-	await replaceStrInFile(
-		`${outputPath}/package.json`,
-		"project_name",
-		projectName,
-	);
-	await replaceStrInFile(
-		`${outputPath}/Cargo.toml`,
-		"project_name",
-		projectName,
-	);
+  createFolder(outputPath);
+  createFolder(`${outputPath}/src`);
+  await copyAllTemplateFiles(outputPath);
+  await replaceStrInFile(
+    `${outputPath}/package.json`,
+    "project_name",
+    projectName,
+  );
+  await replaceStrInFile(
+    `${outputPath}/Cargo.toml`,
+    "project_name",
+    projectName,
+  );
 }