cpoach.sh 0.0.1 → 0.2.0

package/README.md

@@ -1,10 +1,12 @@
-![](https://github.com/user-attachments/assets/459f91c1-c313-4f3a-b4e1-14edc4fb358f)
+<!-- ![](https://github.com/user-attachments/assets/ed3e5a8f-c8df-4644-b643-80620da189fb) -->
 
-**cpoach** is a support tool designed to simplify the use of single-file C/C++ libraries. These libraries can be effortlessly installed via `npm`, making it easier to integrate them into your projects without the hassle of *managing build systems* or including third-party libraries in your version control.
+<p align="center">
+<img src="https://github.com/user-attachments/assets/ed3e5a8f-c8df-4644-b643-80620da189fb" alt="cpoach logo" width="60%"/>
+</p>
 
-<br>
+**cpoach** is a support tool designed to simplify the use of single-file C/C++ libraries. These libraries can be effortlessly installed via `npm`, making it easier to integrate them into your projects without the hassle of *managing build systems* or including third-party libraries in your version control. Refer to the [website](https://nodef.github.io) for the list of available libraries.
 
-## Features
+### Features
 
 - Install and use C/C++ libraries as easily as `#include <stdio.h>`.
 - Libraries are available via NPM for seamless installation.
@@ -28,11 +30,13 @@ npm i -g cpoach.sh
 After installation, you can include the desired libraries in your C/C++ projects. For example, if you want to use the [tigr.c] library for graphics, follow these steps:
 
 Run:
+
 ```bash
 $ npm i tigr.c
 ```
 
 And then include `tigr.h` as follows:
+
 ```c
 // main.c
 #define TIGR_IMPLEMENTATION
@@ -41,14 +45,55 @@ And then include `tigr.h` as follows:
 int main() { /* ... */ }
 ```
 
-And then compile with `clang` or `gcc` as usual.
+And then compile with **clang**, **gcc**, or **MSVC** as follows:
+
+```bash
+$ cpoach clang main.c  # or, use gcc
+$ cpoach gcc   main.c  # or, use MSVC
+$ cpoach cl    main.c
+# NOTE: clang++ and g++ can also be used
+```
+
+You can also manually retrieve the include flags and use them in your compilation command:
 
 ```bash
 $ clang $(cpoach i) main.c  # or, use gcc
-$ gcc   $(cpoach i) main.c
+$ gcc   $(cpoach i) main.c  # or, use MSVC
+$ cl    $(cpoach i --msvc) main.c
+```
+
+On command prompt (Windows), use the following commands instead:
+
+```batch
+> FOR /F "tokens=*" %%i IN ('cpoach i') DO clang++ %%i main.cxx  REM or, use g++
+> FOR /F "tokens=*" %%i IN ('cpoach i') DO g++     %%i main.cxx  REM or, use MSVC
+> FOR /F "tokens=*" %%i IN ('cpoach i --msvc') DO cl %%i main.cxx
 ```
 
-Refer to the [website](https://nodef.github.io) for a categorized list of available libraries.
+As mentioned earlier, the catalog of available libraries is available on the [website](https://nodef.github.io).
+
+[tigr.c]: https://www.npmjs.com/package/tigr.c
+
+<br>
+
+## Documentation
+
+```bash
+$ cpoach [command] [options]
+
+Usage: cpoach [command] [options]
+
+Commands:
+  i | includes         Generate compiler flags for include paths.
+  gcc | clang | cl     Run compiler, passing the include flags.
+
+Options:
+  --compiler [name]    Specify the compiler (msvc, gcc, clang). Default is gcc.
+  --msvc               Shortcut for --compiler msvc.
+  --gcc                Shortcut for --compiler gcc.
+  --clang              Shortcut for --compiler clang.
+  --help               Display help information.
+```
 
 <br>
 
@@ -62,5 +107,3 @@ We welcome contributions! If you have suggestions, please open an issue on our [
 
 [![ORG](https://img.shields.io/badge/org-nodef-green?logo=Org)](https://nodef.github.io)
 ![](https://ga-beacon.deno.dev/G-RC63DPBH3P:SH3Eq-NoQ9mwgYeHWxu7cw/github.com/nodef/cpoach.sh)
-
-[tigr.c]: https://www.npmjs.com/package/tigr.c

package/index.js

@@ -1,18 +1,45 @@
-const fs   = require('fs');
 const path = require('path');
+const fs   = require('fs');
+const cp   = require('child_process');
 
 
-// Run the `includes` command, which generates compiler flags for include paths.
-function runIncludes(opt) {
+// Get compiler type from its name.
+function getCompilerType(name) {
+  name = name.toLowerCase();
+  if (name.includes('msvc') || name.includes('cl'))  return 'msvc';
+  if (name.includes('gcc')  || name.includes('g++')) return 'gcc';
+  if (name.includes('clang')) return 'clang';
+  return null;
+}
+
+
+// Get include paths from the current directory's node_modules.
+function getIncludes(opt) {
   const includes = [];
   const cwd = process.cwd();
   const pth = path.basename(cwd) === 'node_modules'? cwd : path.join(cwd, 'node_modules');
+  if (!fs.existsSync(pth) || !fs.statSync(pth).isDirectory()) return includes;
   for (const ent of fs.readdirSync(pth)) {
     if (!ent.endsWith('.c') && !ent.endsWith('.cxx')) continue;
     includes.push(path.join(pth, ent));
   }
   const FLAG = opt.compiler==='msvc'? '/I' : '-I';
-  console.log(includes.map(pth => `${FLAG}"${pth}"`).join(' ').trim());
+  return includes.map(pth => `${FLAG}"${pth}"`);
+}
+
+
+// Run the `includes` command, which generates compiler flags for include paths.
+function runIncludes(opt) {
+  console.log(getIncludes(opt).join(' ').trim());
+}
+
+
+// Run the `gcc`/`clang`/`cl` command, which runs the compiler with include flags.
+function runCompile(opt) {
+  const includes = getIncludes(opt);
+  const args = [...includes, ...opt.args];
+  try { cp.execFileSync(opt.compiler, args, {encoding: 'utf8', stdio: 'inherit'}); }
+  catch (err) { process.exit(err.status || 1); }
 }
 
 
@@ -23,6 +50,7 @@ function runHelp() {
     `\n` +
     `Commands:\n` +
     `  i | includes         Generate compiler flags for include paths.\n` +
+    `  gcc | clang | cl     Run compiler, passing the include flags.\n` +
     `\n` +
     `Options:\n` +
     `  --compiler [name]    Specify the compiler (msvc, gcc, clang). Default is gcc.\n` +
@@ -36,6 +64,7 @@ function runHelp() {
 // Parse the command name.
 function parseCommand(opt, cmd) {
   if (/i|includes/.test(cmd)) opt.command = 'includes';
+  else if (getCompilerType(cmd)) opt.command = 'compile';
   else opt.error = `Unknown option: ${cmd}`;
 }
 
@@ -47,7 +76,7 @@ function parseArg(opt, argv, k, i) {
   else if (k==='--gcc')   opt.compiler = 'gcc';
   else if (k==='--clang') opt.compiler = 'clang';
   else if (!opt.command)  parseCommand(opt, k);
-  else opt.error = `Unknown option: ${k}`;
+  else if (opt.command !== 'compile') opt.error = `Unknown option: ${k}`;
   return i;
 }
 
@@ -56,11 +85,20 @@ function parseArgs(argv) {
   const opt = {
     error: null,
     help: false,
-    command: 'includes',
-    compiler: 'gcc'
+    command: null,
+    compiler: null,
+    args: [],
   };
   for (let i=2; i<argv.length; i++)
     i = parseArg(opt, argv, argv[i], i);
+  const compiler = getCompilerType(argv[2]);
+  if (compiler) {
+    opt.command  = 'compile';
+    opt.compiler =  compiler;
+    opt.args = argv.slice(3);
+  }
+  opt.command  = opt.command  || 'includes';
+  opt.compiler = opt.compiler || 'gcc';
   return opt;
 }
 
@@ -79,6 +117,7 @@ function main(argv) {
   }
   switch (opt.command) {
     case 'includes': runIncludes(opt); break;
+    case 'compile':  runCompile(opt); break;
     default:
       console.error(`Unknown command: ${opt.command}`);
       process.exit(1);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cpoach.sh",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "description": "Support tool for for easy-to-use, C/C++ libraries that can be effortlessly installed via NPM.",
   "keywords": [
     "c",