chore: rename local option to offline (#1850)

BREAKING CHANGE: `--local` option has been renamed to `--offline`

Author: vasco-santos

src/cli/commands/daemon.js

@@ -26,8 +26,8 @@ module.exports = {
         type: 'boolean',
         default: false
       })
-      .option('local', {
-        desc: 'Run commands locally to the daemon',
+      .option('offline', {
+        desc: 'Run offline. Do not connect to the rest of the network but provide local API.',
         default: false
       })
       .option('enable-namesys-pubsub', {

src/core/components/name.js

@@ -129,9 +129,9 @@ module.exports = function name (self) {
       const nocache = options.nocache && options.nocache.toString() === 'true'
       const recursive = options.recursive && options.recursive.toString() === 'true'
 
-      const local = self._options.local
+      const offline = self._options.offline
 
-      if (!self.isOnline() && !local) {
+      if (!self.isOnline() && !offline) {
         const errMsg = utils.OFFLINE_ERROR
 
         log.error(errMsg)
@@ -140,11 +140,11 @@ module.exports = function name (self) {
 
       // TODO: params related logic should be in the core implementation
 
-      if (local && nocache) {
-        const error = 'cannot specify both local and nocache'
+      if (offline && nocache) {
+        const error = 'cannot specify both offline and nocache'
 
         log.error(error)
-        return callback(errcode(new Error(error), 'ERR_NOCACHE_AND_LOCAL'))
+        return callback(errcode(new Error(error), 'ERR_NOCACHE_AND_OFFLINE'))
       }
 
       // Set node id as name for being resolved, if it is not received

src/core/components/start.js

@@ -67,9 +67,9 @@ module.exports = (self) => {
           ipnsStores.push(pubsubDs)
         }
 
-        // DHT should be added as routing if we are not running with local flag
+        // DHT should be added as routing if we are not running with offline flag
         // TODO: Need to change this logic once DHT is enabled by default, for now fallback to Offline datastore
-        if (get(self._options, 'EXPERIMENTAL.dht', false) && !self._options.local) {
+        if (get(self._options, 'EXPERIMENTAL.dht', false) && !self._options.offline) {
           ipnsStores.push(self.libp2p.dht)
         } else {
           const offlineDatastore = new OfflineDatastore(self._repo)

src/core/config.js

@@ -18,7 +18,7 @@ const schema = Joi.object().keys({
     Joi.object().keys({ bits: Joi.number().integer() })
   ).allow(null),
   start: Joi.boolean(),
-  local: Joi.boolean(),
+  offline: Joi.boolean(),
   pass: Joi.string().allow(''),
   relay: Joi.object().keys({
     enabled: Joi.boolean(),

src/http/index.js

@@ -81,7 +81,7 @@ function HttpApi (repo, config, cliArgs) {
             init: init,
             start: true,
             config: config,
-            local: cliArgs.local,
+            offline: cliArgs.offline,
             pass: cliArgs.pass,
             EXPERIMENTAL: {
               pubsub: cliArgs.enablePubsubExperiment,

test/cli/name.js

@@ -36,7 +36,7 @@ describe('name', () => {
         config: {
           Bootstrap: []
         },
-        args: ['--pass', passPhrase, '--local'],
+        args: ['--pass', passPhrase, '--offline'],
         initOptions: { bits: 512 }
       }, (err, _ipfsd) => {
         expect(err).to.not.exist()