updated documentation website

.gitignore

@@ -67,3 +67,5 @@ toolbox/worky/worky.iml
 /lsp/log/xml_err_20200731.log
 /lsp/log/xml_out_20200730.log
 /lsp/log/xml_out_20200731.log
+/website/nuts/nbproject/private/
+/toolbox/docusaurus-to-asciidoctor/target/

README.md

@@ -1,11 +1,11 @@
 # nuts
 Network Updatable Things Services
 <pre>
- _ __ __
-  / | / /_ __/ /______
-  / |/ / / / / __/ ___/
- / /| / /_/ / /_(__ )
-/_/ |_/\__,_/\__/____/ version 0.7.0.0
+  __  __ 
+ /\ \ \ _ __/ /______ 
+ / \/ / / / / __/ ___/ 
+/ /\ / /_/ / /_(__ ) 
+\_\ \/\__,_/\__/____/  version 0.7.0.0
 </pre>
 
 **nuts** is a Package manager for Java (and other things). It stands for **Network Updatable Things Services** tool. Think of it as **npm** for javascript or **pip** for python. But it lots more... It is a simple tool for managing remote artifacts, installing these artifacts to the current machine and executing such artifacts on need. Each managed artifact is also called a **nuts** which is a **Network Updatable Thing Service** . Nuts artifacts are stored into repositories. A **repository** may be local for storing local Nuts or remote for accessing remote artifacts (good examples are remote maven repositories). 
@@ -25,6 +25,10 @@ What makes **nuts** very helpful is that it simplifies application deployments b
 + search : search for existing/installable artifacts
 + welcome : a command that does nothing but bootstrapping nuts and showing a welcome message.
 
+
+Visit [nuts website](http:https://core-techs-solutions.com/nuts)
+
+
 ## Download Latest stable version
 + Linux,Windows,iOS, and Java enabled OS : [nuts-0.7.0.jar](https://github.com/thevpc/vpc-public-maven/raw/master/net/vpc/app/nuts/nuts/0.7.0/nuts-0.7.0.jar)
 + On Unix/Linux platforms you may use :

README.md.pre

@@ -4,11 +4,11 @@ include("app-include.pre-script");
 # nuts
 Network Updatable Things Services
 <pre>
- _ __ __
-  / | / /_ __/ /______
-  / |/ / / / / __/ ___/
- / /| / /_/ / /_(__ )
-/_/ |_/\__,_/\__/____/ version ${implVersion}
+  __  __ 
+ /\ \ \ _ __/ /______
+ / \/ / / / / __/ ___/
+/ /\ / /_/ / /_(__ )
+\_\ \/\__,_/\__/____/  version ${implVersion}
 </pre>
 
 **nuts** is a Package manager for Java (and other things). It stands for **Network Updatable Things Services** tool. Think of it as **npm** for javascript or **pip** for python. But it lots more... It is a simple tool for managing remote artifacts, installing these artifacts to the current machine and executing such artifacts on need. Each managed artifact is also called a **nuts** which is a **Network Updatable Thing Service** . Nuts artifacts are stored into repositories. A **repository** may be local for storing local Nuts or remote for accessing remote artifacts (good examples are remote maven repositories). 

nuts-core/src/main/java/net/vpc/app/nuts/main/repocommands/DefaultNutsDeployRepositoryCommand.java

@@ -40,6 +40,7 @@
 /**
  *
  * @author vpc
+ * @category SPI Base
  */
 public class DefaultNutsDeployRepositoryCommand extends AbstractNutsDeployRepositoryCommand {
 

nuts-core/src/main/java/net/vpc/app/nuts/main/repocommands/DefaultNutsFetchContentRepositoryCommand.java

@@ -41,6 +41,7 @@
 /**
  *
  * @author vpc
+ * @category SPI Base
  */
 public class DefaultNutsFetchContentRepositoryCommand extends AbstractNutsFetchContentRepositoryCommand {
 

nuts-core/src/main/java/net/vpc/app/nuts/main/repocommands/DefaultNutsFetchDescriptorRepositoryCommand.java

@@ -44,6 +44,7 @@
 
 /**
  * @author vpc
+ * @category SPI Base
  */
 public class DefaultNutsFetchDescriptorRepositoryCommand extends AbstractNutsFetchDescriptorRepositoryCommand {
 

nuts-core/src/main/java/net/vpc/app/nuts/main/repocommands/DefaultNutsPushRepositoryCommand.java

@@ -20,6 +20,7 @@
 /**
  *
  * @author vpc
+ * @category SPI Base
  */
 public class DefaultNutsPushRepositoryCommand extends AbstractNutsPushRepositoryCommand {
  private final NutsLogger LOG;

nuts-core/src/main/java/net/vpc/app/nuts/main/repocommands/DefaultNutsRepositoryUndeployCommand.java

@@ -17,6 +17,7 @@
 /**
  *
  * @author vpc
+ * @category SPI Base
  */
 public class DefaultNutsRepositoryUndeployCommand extends AbstractNutsRepositoryUndeployCommand {
 

nuts-core/src/main/java/net/vpc/app/nuts/main/repocommands/DefaultNutsSearchRepositoryCommand.java

@@ -20,6 +20,7 @@
 /**
  *
  * @author vpc
+ * @category SPI Base
  */
 public class DefaultNutsSearchRepositoryCommand extends AbstractNutsSearchRepositoryCommand {
 

nuts-core/src/main/java/net/vpc/app/nuts/main/repocommands/DefaultNutsSearchVersionsRepositoryCommand.java

@@ -21,6 +21,7 @@
 
 /**
  * @author vpc
+ * @category SPI Base
  */
 public class DefaultNutsSearchVersionsRepositoryCommand extends AbstractNutsSearchVersionsRepositoryCommand {
 

nuts-core/src/main/java/net/vpc/app/nuts/runtime/format/xml/DefaultNutsXmlFormat.java

@@ -534,16 +534,6 @@ public boolean isCompact() {
  return compact;
  }
 
- @Override
- public NutsXmlFormat compact() {
- return compact(true);
- }
-
- @Override
- public NutsXmlFormat compact(boolean compact) {
- return setCompact(compact);
- }
-
  @Override
  public NutsXmlFormat setCompact(boolean compact) {
  this.compact = compact;

nuts-core/src/main/java/net/vpc/app/nuts/runtime/io/DefaultNutsIOCopyAction.java

@@ -254,7 +254,6 @@ public NutsSession getSession() {
  return session;
  }
 
-
  @Override
  public NutsIOCopyAction setSession(NutsSession session) {
  this.session = session;
@@ -307,6 +306,7 @@ public NutsIOCopyAction run() {
  }
 
  private static class CopyData {
+
  long files;
  long folders;
  long doneFiles;
@@ -396,11 +396,11 @@ public FileVisitResult postVisitDirectory(Path dir, IOException exc) throws IOEx
  }
 
  public Path copy(Path source, Path target, CopyOption... options) throws IOException {
- if(interruptible){
- try(InputStream in=CoreIOUtils.interruptible(Files.newInputStream(source))){
- interruptibleInstance=(Interruptible) in;
- try(OutputStream out=Files.newOutputStream(target)){
- transferTo(in,out);
+ if (interruptible) {
+ try (InputStream in = CoreIOUtils.interruptible(Files.newInputStream(source))) {
+ interruptibleInstance = (Interruptible) in;
+ try (OutputStream out = Files.newOutputStream(target)) {
+ transferTo(in, out);
  }
  }
  return target;
@@ -410,37 +410,37 @@ public Path copy(Path source, Path target, CopyOption... options) throws IOExcep
 
  public long copy(InputStream in, Path target, CopyOption... options)
  throws IOException {
- if(interruptible){
- in=CoreIOUtils.interruptible(in);
- interruptibleInstance=(Interruptible) in;
- try(OutputStream out=Files.newOutputStream(target)){
- return transferTo(in,out);
+ if (interruptible) {
+ in = CoreIOUtils.interruptible(in);
+ interruptibleInstance = (Interruptible) in;
+ try (OutputStream out = Files.newOutputStream(target)) {
+ return transferTo(in, out);
  }
  }
  return Files.copy(in, target, options);
  }
 
  public long copy(InputStream in, OutputStream out, CopyOption... options)
  throws IOException {
- if(interruptible){
- in=CoreIOUtils.interruptible(in);
- interruptibleInstance=(Interruptible) in;
- return transferTo(in,out);
+ if (interruptible) {
+ in = CoreIOUtils.interruptible(in);
+ interruptibleInstance = (Interruptible) in;
+ return transferTo(in, out);
  }
  return CoreIOUtils.copy(in, out);
  }
 
  public long copy(Path source, OutputStream out) throws IOException {
- if(interruptible){
- try(InputStream in=CoreIOUtils.interruptible(Files.newInputStream(source))){
- interruptibleInstance=(Interruptible) in;
- return transferTo(in,out);
+ if (interruptible) {
+ try (InputStream in = CoreIOUtils.interruptible(Files.newInputStream(source))) {
+ interruptibleInstance = (Interruptible) in;
+ return transferTo(in, out);
  }
  }
  return Files.copy(source, out);
  }
 
- private long transferTo(InputStream in,OutputStream out) throws IOException {
+ private long transferTo(InputStream in, OutputStream out) throws IOException {
  int DEFAULT_BUFFER_SIZE = 8192;
  Objects.requireNonNull(out, "out");
  long transferred = 0;
@@ -604,7 +604,7 @@ private void copyStream() {
  }
  }
  } catch (IOException ex) {
- LOG.with().level(Level.CONFIG).verb(NutsLogVerb.FAIL).log( "error copying {0} to {1} : {2}", _source.getSource(), target.getValue(), ex.toString());
+ LOG.with().level(Level.CONFIG).verb(NutsLogVerb.FAIL).log("error copying {0} to {1} : {2}", _source.getSource(), target.getValue(), ex.toString());
  throw new UncheckedIOException(ex);
  }
  }
@@ -616,7 +616,7 @@ private void _validate(Path temp) {
  } catch (NutsIOCopyValidationException ex) {
  throw ex;
  } catch (Exception ex) {
- throw new NutsIOCopyValidationException("Validate file " + temp + " failed", ex);
+ throw new NutsIOCopyValidationException(session.getWorkspace(), "Validate file " + temp + " failed", ex);
  }
  }
  }
@@ -628,7 +628,7 @@ private void _validate(byte[] temp) {
  } catch (NutsIOCopyValidationException ex) {
  throw ex;
  } catch (Exception ex) {
- throw new NutsIOCopyValidationException("Validate file failed", ex);
+ throw new NutsIOCopyValidationException(session.getWorkspace(), "Validate file failed", ex);
  }
  }
  }

nuts-core/src/main/java/net/vpc/app/nuts/runtime/repocommands/AbstractNutsDeployRepositoryCommand.java

@@ -40,6 +40,7 @@
 /**
  *
  * @author vpc
+ * @category SPI Base
  */
 public abstract class AbstractNutsDeployRepositoryCommand extends NutsRepositoryCommandBase<NutsDeployRepositoryCommand> implements NutsDeployRepositoryCommand {
 

nuts-core/src/main/java/net/vpc/app/nuts/runtime/repocommands/AbstractNutsFetchContentRepositoryCommand.java

@@ -36,6 +36,7 @@
 /**
  *
  * @author vpc
+ * @category SPI Base
  */
 public abstract class AbstractNutsFetchContentRepositoryCommand extends NutsRepositoryCommandBase<NutsFetchContentRepositoryCommand> implements NutsFetchContentRepositoryCommand {
 

nuts-core/src/main/java/net/vpc/app/nuts/runtime/repocommands/AbstractNutsFetchDescriptorRepositoryCommand.java

@@ -34,6 +34,7 @@
 /**
  *
  * @author vpc
+ * @category SPI Base
  */
 public abstract class AbstractNutsFetchDescriptorRepositoryCommand extends NutsRepositoryCommandBase<NutsFetchDescriptorRepositoryCommand> implements NutsFetchDescriptorRepositoryCommand {
 

nuts-core/src/main/java/net/vpc/app/nuts/runtime/repocommands/AbstractNutsPushRepositoryCommand.java

@@ -14,6 +14,7 @@
 
 /**
  * @author vpc
+ * @category SPI Base
  */
 public abstract class AbstractNutsPushRepositoryCommand extends NutsRepositoryCommandBase<NutsPushRepositoryCommand> implements NutsPushRepositoryCommand {
 

nuts-core/src/main/resources/net/vpc/app/nuts/includes/standard-header.help

@@ -1,6 +1,6 @@
-== _ _\_ _\_ ==
-==  / | / /_ _\_/ /_\_\_\_\_\_ == ==N==etwork ==U==pdatable ==T==hings ==S==ervices
-==  / |/ / / / / _\_/ _\_\_/ == <<The Open Source Package Manager for __Java__ (TM)>>
-== / /| / /_/ / /_\(_\_ \) == <<and other __Things__>> ... by ==thevpc==
-==/_/ |_/\\_\_,_/\\_\_/_\_\_\_/ == __http:https://github.com/thevpc/nuts__
- version [[${nuts.workspace-runtime.version}]]
+==  _\_  _\_ ==
+== /\\ \\ \\ _ _\_/ /_\_\_\_\_\_ == ==N==etwork ==U==pdatable ==T==hings ==S==ervices
+== / \\/ / / / / _\_/ _\_\_/ == <<The Open Source Package Manager for __Java__ (TM)>>
+==/ /\\ / /_/ / /_(_\_ ) == <<and other __Things__>> ... by ==thevpc==
+==\\_\\ \\/\\_\_,_/\\_\_/_\_\_\_/  == __http:https://github.com/thevpc/nuts__ 
+ version [[${nuts.workspace-runtime.version}]]

nuts/pom.xml

@@ -104,6 +104,22 @@
  </goals>
  </execution>
  </executions>
+ <configuration>
+ <tags>
+ <tag>
+ <name>todo</name>
+ <!-- todo tag for all places -->
+ <placement>a</placement>
+ <head>To do something:</head>
+ </tag>
+ <tag>
+ <name>category</name>
+ <!-- todo tag for all places -->
+ <placement>a</placement>
+ <head>Category:</head>
+ </tag>
+ </tags> 
+ </configuration>
  </plugin>
  <plugin>
  <groupId>net.vpc.common.maven</groupId>

nuts/src/main/java/net/vpc/app/nuts/Nuts.java

@@ -36,6 +36,7 @@
  * it's main class for creating and opening nuts workspaces.
  *
  * @since 0.1.0
+ * @category Base
  */
 public final class Nuts {
 

nuts/src/main/java/net/vpc/app/nuts/NutsAddOptions.java

@@ -43,6 +43,7 @@
  * @see NutsWorkspaceConfigManager#addCommandAliasFactory(net.vpc.app.nuts.NutsCommandAliasFactoryConfig,
  * net.vpc.app.nuts.NutsAddOptions)
  * @since 0.5.4
+ * @category Config
  */
 public class NutsAddOptions implements Serializable {
  private static final long serialVersionUID = 1;

nuts/src/main/java/net/vpc/app/nuts/NutsAddRepositoryOptions.java

@@ -36,6 +36,7 @@
  * repository creation options
  * @author vpc
  * @since 0.5.4
+ * @category Config
  */
 public class NutsAddRepositoryOptions implements Serializable {
  private static final long serialVersionUID = 1;

nuts/src/main/java/net/vpc/app/nuts/NutsAddUserCommand.java

@@ -40,6 +40,7 @@
  *
  * @author vpc
  * @since 0.5.5
+ * @category Security
  */
 public interface NutsAddUserCommand extends NutsWorkspaceCommand {
 

nuts/src/main/java/net/vpc/app/nuts/NutsAlreadyDeployedException.java

@@ -34,6 +34,7 @@
  * already deployed Created by vpc on 1/15/17.
  *
  * @since 0.5.4
+ * @category Exception
  */
 public class NutsAlreadyDeployedException extends NutsInstallationException {
 

nuts/src/main/java/net/vpc/app/nuts/NutsAlreadyInstalledException.java

@@ -34,6 +34,7 @@
  * reinstalled Created by vpc on 1/15/17.
  *
  * @since 0.5.4
+ * @category Exception
  */
 public class NutsAlreadyInstalledException extends NutsInstallationException {
 

nuts/src/main/java/net/vpc/app/nuts/NutsApplication.java

@@ -156,6 +156,7 @@
  * </pre>
  *
  * @since 0.5.5
+ * @category Application
  */
 public abstract class NutsApplication {
 

nuts/src/main/java/net/vpc/app/nuts/NutsApplicationContext.java

@@ -37,6 +37,7 @@
  *
  * @author vpc
  * @since 0.5.5
+ * @category Application
  */
 public interface NutsApplicationContext extends NutsConfigurable {
 

nuts/src/main/java/net/vpc/app/nuts/NutsApplicationLifeCycle.java

@@ -36,6 +36,7 @@
  *
  * @author vpc
  * @since 0.5.5
+ * @category Application
  */
 public interface NutsApplicationLifeCycle {
 

nuts/src/main/java/net/vpc/app/nuts/NutsApplicationMode.java

@@ -4,6 +4,7 @@
  * Modes Application can run with
  *
  * @since 0.5.5
+ * @category Application
  */
 public enum NutsApplicationMode {
  /**

nuts/src/main/java/net/vpc/app/nuts/NutsApplications.java

@@ -39,6 +39,7 @@
  *
  * @author vpc
  * @since 0.5.5
+ * @category Application
  */
 public final class NutsApplications {