What is the syntax to provide a commit message or in general an argument for an option?

Git["commit", "-m test"] (or)
Git["commit", "-m", "test"]

both end up with 'Commited by Mathematica'.

1. Is the config folder defined by yourself, can I extend the definition inside?

2. What do the files inside mean?

3. Is it possible to provide something like $PackageConfig, which can be used to conveniently store persistent data?

$PackageConfig["RemovePath", Bundle] = XXX

May works like InitializationValue and PersistentValue

<< BTools`External`
GitHub["ListRepositories", "b3m2a1"]

It will ask you to login, you can login provide wrong credentials or cancel and it will return ListRepositories result anyway. It should not ask I guess.

As per se post Git[" is supposed to trigger autocompletion menu, which it does not for me. (v2.1.27 MMA v11.3+ Win7/10)

BTools["AllowAutocompletions"]

BToolsPackageScopePrivateConstants$TopLevelLoad

TL;DR;

It would be nice to have a short wiki with common development use cases / step and corresponding functions that achieve those goals.

Background

Very often I don't need golden hammer solutions but an access to those tiny features. I believe I'm not the only one as for anything more complex than a package there is hardly any widely established standard.

Todo

So, in order to list those functions / lack of them we need to prepare a list of steps / use cases.

Here is a start, it is biased so needs to be refactored and extended before publishing.

Creation / Development

• newProject(type)
• newProjectContent(type) (todo: expand)
• createPacletInfo(initAssociationWithRequiredFields)
• mmaProjectGitInit()
• createTests()

Build dev/prod

PacletInfo:

• modifyPacletInfo(key:value)
• handy PI getters
• incrementVersion(major|minor|patch : patch)
• addExtension(fe|docs|resource)

Kernel:

• addSubpackage(packageTemplateType)

FrontEnd

• addStylesheet()

Documentation:

• newDocPage(sym|tutorial|guide|...)
• buildDocs()

Tests:

• runTests()

Resources:

...

Git:

• gitCommit(msg, type) => (add . + commit(msg, type))
  // by type I assume (in future) support for something like https://conventionalcommits.org/spec/v1.0.0-beta.1.html

Release / Deployment

• gitTag() // at least git tag -a -m {most recent feat(_) commit msg} v{paclet version}
• release as github asset

The idea is to outline more than it is to know which features need care.

A small suggestion for DocGen family.

Since the target group are third party packages maybe generated symbols etc. notebooks should have CellContext -> Notebook or even Global` , though Notebook will be better.

The reason is Needs["myPackage`"] in an intialization cell does not do much since every cell group has separate $ContextPath. One still needs to use full names or change CellContext themself, which will be confusing for newbies.

This is the case in the ordinary case:

BeginPackage["xxx`",{"JLink`"}]
Begin["`xxx`"]

JavaNew["..."]

End[]
EndPackage[]

Now with the Loader.m, no longer needed write BeginPackage.

But also can't specify Contexts, so I must write:

Begin["`xxx`"]

JLink`JavaNew["..."]

End[]

Is there any way to add JLink to all sub-packages?

Now I'm working on a project created by BTools 2.0.

There're still some small problems.

Here's the broken version, it can be reproduced on today's ver BTools 2.0.18

https://github.com/wjxway/ZhihuLink-Mathematica/releases/download/v0.1.13/ZhihuLink-0.1.13.paclet

I use the old Loader.m created by BTools 1.0 and then it works.

oovm/ZhihuLink@3502f8c#diff-48f59ab175e2bd47a999a3bce0fcd970

First can't use Get to import the created package.

Because "%\\AppData\\Roaming\\Mathematica\\Paclets\\Applications" doesn't in the $Path.

Second, what else should I do after I create a package named "mytest.m" in "\\Package".

I tried <<mytest` but Get can't find the path.

Moreover, buttons in Docs run but nothing was generated in "\\Documentation".

GenerateSymbolPages@fun works fine butGenerateDocumentation@"DocGen`" only return a empty notebook says

There are no symbols in the DocGen context.

Maybe I missing some settings.

Hi there,

[MacOS 10.14, Mathematica 11.2]

I'm not sure if this repo is still being maintained; if not, please point me to whatever these tools have since become!
I'm trying to generate HTML doc of a paclet (one of your own, as a test).

I've installed BTools, and its doc, via

PacletInstall["BTools", "Site" -> "http://www.wolframcloud.com/objects/b3m2a1.paclets/PacletServer"]
PacletInstall["Documentation_BToolsWeb", "Site" -> "http://www.wolframcloud.com/objects/b3m2a1.docs/DocumentationServer"]

I try to generate HTML doc (as a test) via

<< BTools`Paclets`

DocGen["HTML", PacletFind["Documentation_BToolsWeb"]]

but after some fuss, the DocGen call throws:

Throw: Uncaught Throw[False] returned to top level

I can see it has only generated files css, images and javascript at Mathematica/ApplicationData/DocGen/Web, but nothing more.

Running DocGen["HTML", PacletFind["Documentation_BToolsWeb"]] agains spits out more errors which indicate those created files were intended as directories. Starting over, and creating css, images, javascript directories in advance, offers new errors of

LinkObject: Argument I'm trying to get rid of this in I'm trying to get rid of this is not a valid LinkObject

I suppose the project isn't in a working state for MacOS; is there another way I can generate Mathematica Doc Centre style HTML documentation using BTools, or a derivative project?

Due to BTools' heavy use of URLRead I think it requires 11+ restriction. Or at least messages for features affected by missing functionalities.

On Windows

Git["HelpDescription", "add"]

None

Because git is launching web docs for git help.

Let's e.g. GitHub["CreateRepository", "temp"]. It will ask you to login with BTools' dialog (blue header). If credentials are invalid the second prompt will be different, I guess it is the native one but it is slightly different than the default for URLRead and friends. Anyway, whatever you put there you will get 401 response, even if this time credentials were ok.

Can you reproduce the problem?

Git["reset","HEAD~"]

fatal: 'HEAD~' does not appear to be a git repository
fatal: Could not read from remote repository.
Please make sure you have the correct access rights
and the repository exists."

What am I doing wrong?

cmd version returns:

Unstaged changes after reset:
M path/to/file

Now let's talk about the documentations generation.

First I load my application.

Then run some functions to activate all packages

At last, using GenerateDocumentation to generate the documentations.

I find that in "%AppData%\Roaming\Mathematica\ApplicationData\DocGen\DocPaclets".

Everything works good, but when I copy them to "myPackage\Documentation", all links are broken.

And all the documentations can't be found by searching or F1.

The function System`Private`HasOwnCodeQ doesn't exist anymore in V13.3 and therefore the argument to If is neither True/False. This results in the whole block being included as a string in the generated notebook.
ASFAIK there is only one instance of this function in use in Packages/Paclets/DocGen/SymbolPages.m.

When trying to run :

PacletInstall["ServiceConnection_GoogleDrive", 
 "Site" -> 
  "http://www.wolframcloud.com/objects/b3m2a1.paclets/PacletServer"]

I get these errors:

PacletSiteUpdate::err: An error occurred attempting to update paclet information from site http://www.wolframcloud.com/objects/b3m2a1.paclets/PacletServer. Server returned HTTP status code 401.

PacletInstall::notavail: No paclet named ServiceConnection_GoogleDrive is available for download from any currently enabled paclet sites.

What if the API gateway, e.g. GitHub does not support a specific method due to whatever reason? Is there a natural way to make that call anyway? If not, there should be :)

If there is no general way, it should be mentioned what internal functions can be used to assemble the call.

With respect to GitHub only authorization patch is needed and I guess many will be fine with writting HTTPRequest by themselves.