occam-open-cli 5.0.126 → 5.0.128

package/README.md

@@ -2,22 +2,19 @@
 
 [Occam](https://github.com/djalbat/occam)'s c**o**mmand line **p**ackag**e** manageme**n**t tool.
 
+*This readme file is mostly for developers. For instructions tailored to end users, see the following:*
+
+https://openmathematics.org/how-to-contribute
+
 ### Contents
 
-- [Introduction](#introduction)
 - [Installation](#installation)
 - [Usage](#usage)
 - [Building](#building)
 - [Contact](#contact)
 
-## Introduction
-
-The `open` command line tool provides similar functionality to [`npm`](https://www.npmjs.com/), but for[Occam packages. Published packages appear on the [Open Mathematics](https://openmathematics.org) website and can be utilised in Occam.
-
 ## Installation
 
-If you are an end user, you can install `open` via `npm`. Instructions for doing so, together with other relevant information, can be found in the 'How to contribute' section on the front page of the aforementioned Open Mathematics website.
-
 If you would like to contribute or would simply like to have a look at the code, you can clone the repository with [Git](https://git-scm.com/)...
 
     git clone https://github.com/djalbat/occam-open-cli.git
@@ -72,27 +69,7 @@ Options:
   --yes|-y                                       Initially answer yes to prompts
 ```
 
-This is slightly different from `npm` in that `open` is usually executed from the parent directory of a project rather than from within the project sub-directory itself. Projects might reside in a `~/Mathematics/` directory, for example, in which case you should initialise `open` in there:
-
-    open initialise
-
-This will create a hidden `.openrc` file which you should never share. The reason is that if you log in to or register with the Open Mathematics site, your access token will be stored in this hidden file.
-
-If you wish to publish the `induction` package, say, assuming that you have a sub-directory called `induction` for that package, run the following:
-
-    open publish induction
-
-Actually you can in fact get away with publishing from within projects' sub-directories by running `open publish` in them, in which cases `open` will go up one directory in order to find the `.openrc` file and figure out the package name for itself.
-
-Bear in mind that Occam does not as yet directly support packages. Therefore for now it is best to clone them, which you can again do with `open`. For example:
-
-    open clone natural-numbers
-
-In these cases `open` will recover the underlying GitHub repository from the package's meta-data and clone the repository for you. If you just wanted the bare package and not the repository, the following would suffice:
-
-    open natural-numbers
-
-Both Occam and the Open Mathematics site are works in progress, as indeed is `open`. The remainder of this readme file gives some of the current thinking on versioning and so forth that has yet to be implemented.
+This is slightly different from `npm` in that `open` is usually executed from the parent directory of a project rather than from within the project sub-directory itself.
 
 ## Building
 

package/bin/operation/cloneReleases.js

@@ -31,13 +31,11 @@ function cloneReleasePromptOperation(release, next, done, context, index) {
     }
   }
 
-  const { name } = release,
+  const { name, quietly } = release,
         entryPath = name, ///
         entryExists = checkEntryExists(entryPath);
 
   if (entryExists) {
-    const { quietly } = context;
-
     if (!quietly) {
       console.log(`Cannot clone the '${name}' package because a directory of that name already exists.`);
     }
@@ -49,10 +47,10 @@ function cloneReleasePromptOperation(release, next, done, context, index) {
 
   done = next;  ///
 
-  cloneRelease(release, done);
+  cloneRelease(release, quietly, done);
 }
 
-function cloneRelease(release, done) {
+function cloneRelease(release, quietly, done) {
   let repository = repositoryFromRelease(release)
 
   const options = getOptions(),
@@ -71,6 +69,12 @@ function cloneRelease(release, done) {
       console.log(error);
     }
 
+    if (!quietly) {
+      const { name } = release;
+
+      console.log(name);
+    }
+
     done();
   });
 }
@@ -85,4 +89,4 @@ function repositoryFromRelease(release) {
   const repository = entries.getRepository();
 
   return repository;
-}
+}

package/bin/operation/openReleases.js

@@ -22,12 +22,12 @@ function openReleasesOperation(proceed, abort, context) {
 module.exports = openReleasesOperation;
 
 function openReleasePromptOperation(release, next, done, context) {
-  const { name } = release,
+  const { name, quietly } = release,
         entryPath = name, ///
         entryExists = checkEntryExists(entryPath);
 
   if (!entryExists) {
-    openRelease(release);
+    openRelease(release, quietly);
 
     next();
 
@@ -37,8 +37,6 @@ function openReleasePromptOperation(release, next, done, context) {
   const entryDirectory = isEntryDirectory(entryPath);
 
   if (entryDirectory) {
-    const { quietly } = context;
-
     if (!quietly) {
       console.log(`Cannot open the '${name}' package because a directory of that name already exists.`);
     }
@@ -71,7 +69,7 @@ function openReleasePromptOperation(release, next, done, context) {
       if (affirmative) {
         removeEntry(entryPath);
 
-        openRelease(release);
+        openRelease(release, quietly);
       }
 
       next();
@@ -79,7 +77,7 @@ function openReleasePromptOperation(release, next, done, context) {
   });
 }
 
-function openRelease(release) {
+function openRelease(release, quietly) {
   const { name } = release,
         filePath = name,  ///
         releaseJSON = release,  ///
@@ -87,4 +85,8 @@ function openRelease(release) {
         content = releaseJSONString; ///
 
   writeFile(filePath, content);
+
+  if (!quietly) {
+    console.log(name);
+  }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "occam-open-cli",
   "author": "James Smith",
-  "version": "5.0.126",
+  "version": "5.0.128",
   "license": "MIT, Anti-996",
   "homepage": "https://github.com/djalbat/occam-open-cli",
   "description": "Occam's command line package management tool.",