@bivabdas/sharq 1.0.0 → 1.0.1

package/README.md

@@ -2,6 +2,8 @@
 
 `sharq` is a minimal static rendering framework for landing pages and Markdown-driven blogs. It generates crawl-friendly HTML, keeps output on disk, and can scaffold a new site with a single command.
 
+Published on npm as `@bivabdas/sharq`.
+
 ## Features
 
 - Markdown posts with frontmatter
@@ -12,8 +14,22 @@
 
 ## Install
 
+Create a new site:
+
+```bash
+npx @bivabdas/sharq create my-site
+```
+
+Install globally:
+
+```bash
+npm install -g @bivabdas/sharq
+```
+
+Install in an existing project:
+
 ```bash
-npm install sharq
+npm install @bivabdas/sharq
 ```
 
 ## CLI

package/bin/create-sharq.js

@@ -2,14 +2,17 @@
 
 import path from "node:path";
 import { fileURLToPath } from "node:url";
-import { readPackageVersion } from "../lib/package-info.js";
+import { readPackageName, readPackageVersion } from "../lib/package-info.js";
 import { scaffoldProject } from "../lib/scaffold.js";
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 const packageRoot = path.resolve(__dirname, "..");
 const projectName = process.argv[2];
-const packageVersion = await readPackageVersion(packageRoot);
+const [packageName, packageVersion] = await Promise.all([
+  readPackageName(packageRoot),
+  readPackageVersion(packageRoot)
+]);
 
 if (projectName === "--help" || projectName === "-h" || projectName === "help") {
   console.log(`create-sharq v${packageVersion}
@@ -23,6 +26,7 @@ Usage:
 const project = await scaffoldProject({
   packageRoot,
   frameworkVersion: `^${packageVersion}`,
+  frameworkPackageName: packageName,
   projectName
 });
 

package/bin/sharq.js

@@ -4,7 +4,7 @@ import path from "node:path";
 import { fileURLToPath } from "node:url";
 import { resolveConfig } from "../lib/config.js";
 import { buildStaticSite } from "../lib/generator.js";
-import { readPackageVersion } from "../lib/package-info.js";
+import { readPackageName, readPackageVersion } from "../lib/package-info.js";
 import { startServer } from "../lib/server.js";
 import { scaffoldProject } from "../lib/scaffold.js";
 
@@ -12,7 +12,10 @@ const [, , command, projectName] = process.argv;
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 const packageRoot = path.resolve(__dirname, "..");
-const packageVersion = await readPackageVersion(packageRoot);
+const [packageName, packageVersion] = await Promise.all([
+  readPackageName(packageRoot),
+  readPackageVersion(packageRoot)
+]);
 
 function printHelp() {
   console.log(`sharq v${packageVersion}
@@ -43,6 +46,7 @@ if (!command || command === "dev" || command === "start") {
   const project = await scaffoldProject({
     packageRoot,
     frameworkVersion: `^${packageVersion}`,
+    frameworkPackageName: packageName,
     projectName
   });
 

package/lib/package-info.js

@@ -1,8 +1,17 @@
 import fs from "node:fs/promises";
 import path from "node:path";
 
-export async function readPackageVersion(packageRoot) {
+async function readPackageJson(packageRoot) {
   const packageJsonPath = path.join(packageRoot, "package.json");
-  const packageJson = JSON.parse(await fs.readFile(packageJsonPath, "utf8"));
+  return JSON.parse(await fs.readFile(packageJsonPath, "utf8"));
+}
+
+export async function readPackageVersion(packageRoot) {
+  const packageJson = await readPackageJson(packageRoot);
   return packageJson.version;
 }
+
+export async function readPackageName(packageRoot) {
+  const packageJson = await readPackageJson(packageRoot);
+  return packageJson.name;
+}

package/lib/scaffold.js

@@ -64,7 +64,7 @@ function resolveLocalDependencySpec(projectDir, packageRoot) {
   return `file:${relativePath}`;
 }
 
-async function writePackageJson(projectDir, projectName, frameworkDependency) {
+async function writePackageJson(projectDir, projectName, frameworkPackageName, frameworkDependency) {
   const packageJson = {
     name: projectName,
     version: "0.1.0",
@@ -76,7 +76,7 @@ async function writePackageJson(projectDir, projectName, frameworkDependency) {
       build: "sharq build"
     },
     dependencies: {
-      sharq: frameworkDependency
+      [frameworkPackageName]: frameworkDependency
     }
   };
 
@@ -153,7 +153,12 @@ export async function scaffoldProject(options = {}) {
 
   const templateDir = path.join(packageRoot, "scaffold", "template");
   await copyDir(templateDir, projectDir);
-  await writePackageJson(projectDir, answers.projectName, frameworkDependency);
+  await writePackageJson(
+    projectDir,
+    answers.projectName,
+    options.frameworkPackageName || "@bivabdas/sharq",
+    frameworkDependency
+  );
   await writeConfig(projectDir, answers);
   await writeReadme(projectDir, answers);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bivabdas/sharq",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Minimal on-demand static rendering framework and scaffolder",
   "license": "MIT",
   "keywords": [