This directory is determined by first checking the presence of a
ourbigbook.json
file.If a
ourbigbook.json
is found, then the project toplevel directory is the directory that contains that file.- otherwise, if the input path is a descendant of the current working directory, then the current working directory is used, see also: the current working directory does not matter when there is a
ourbigbook.json
- otherwise, if the input path is a directory, it is used
- otherwise, the directory containing the input file is used
For example, consider the file following file structure relative to the current working directory:
path/to/notindex.bigb
In this case:
- if there is no
ourbigbook.json
file:- if we run
ourbigbook .
: the toplevel directory is the current directory.
, and sonotindex.bigb
has IDpath/to/notindex
- if we run
ourbigbook path
: same - if we run
ourbigbook path/to
: same - if we run
ourbigbook path/to/notindex.bigb
: same
- if we run
- if there is a
path/ourbigbook.json
file:- if we run
ourbigbook .
: the toplevel directory is the current directory.
because theourbigbook.json
is below the entry point and is not seen, and sonotindex.bigb
has IDpath/to/notindex
- if we run
ourbigbook path
: the toplevel directory is the directory with theourbigbook.json
,path
, and sonotindex.bigb
has IDto/notindex
- if we run
ourbigbook path/to
: same - if we run
ourbigbook path/to/notindex.bigb
: same
- if we run