@jbrowse/cli 2.10.1 → 2.10.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -205,7 +205,7 @@ EXAMPLES
205
205
  ```
206
206
 
207
207
  _See code:
208
- [src/commands/add-assembly.ts](https://github.com/GMOD/jbrowse-components/blob/v2.10.1/products/jbrowse-cli/src/commands/add-assembly.ts)_
208
+ [src/commands/add-assembly.ts](https://github.com/GMOD/jbrowse-components/blob/v2.10.2/products/jbrowse-cli/src/commands/add-assembly.ts)_
209
209
 
210
210
  ## `jbrowse add-connection CONNECTIONURLORPATH`
211
211
 
@@ -256,7 +256,7 @@ EXAMPLES
256
256
  ```
257
257
 
258
258
  _See code:
259
- [src/commands/add-connection.ts](https://github.com/GMOD/jbrowse-components/blob/v2.10.1/products/jbrowse-cli/src/commands/add-connection.ts)_
259
+ [src/commands/add-connection.ts](https://github.com/GMOD/jbrowse-components/blob/v2.10.2/products/jbrowse-cli/src/commands/add-connection.ts)_
260
260
 
261
261
  ## `jbrowse add-track TRACK`
262
262
 
@@ -337,7 +337,7 @@ EXAMPLES
337
337
  ```
338
338
 
339
339
  _See code:
340
- [src/commands/add-track.ts](https://github.com/GMOD/jbrowse-components/blob/v2.10.1/products/jbrowse-cli/src/commands/add-track.ts)_
340
+ [src/commands/add-track.ts](https://github.com/GMOD/jbrowse-components/blob/v2.10.2/products/jbrowse-cli/src/commands/add-track.ts)_
341
341
 
342
342
  ## `jbrowse add-track-json TRACK`
343
343
 
@@ -367,7 +367,7 @@ EXAMPLES
367
367
  ```
368
368
 
369
369
  _See code:
370
- [src/commands/add-track-json.ts](https://github.com/GMOD/jbrowse-components/blob/v2.10.1/products/jbrowse-cli/src/commands/add-track-json.ts)_
370
+ [src/commands/add-track-json.ts](https://github.com/GMOD/jbrowse-components/blob/v2.10.2/products/jbrowse-cli/src/commands/add-track-json.ts)_
371
371
 
372
372
  ## `jbrowse admin-server`
373
373
 
@@ -399,7 +399,7 @@ EXAMPLES
399
399
  ```
400
400
 
401
401
  _See code:
402
- [src/commands/admin-server.ts](https://github.com/GMOD/jbrowse-components/blob/v2.10.1/products/jbrowse-cli/src/commands/admin-server.ts)_
402
+ [src/commands/admin-server.ts](https://github.com/GMOD/jbrowse-components/blob/v2.10.2/products/jbrowse-cli/src/commands/admin-server.ts)_
403
403
 
404
404
  ## `jbrowse create LOCALPATH`
405
405
 
@@ -456,7 +456,7 @@ EXAMPLES
456
456
  ```
457
457
 
458
458
  _See code:
459
- [src/commands/create.ts](https://github.com/GMOD/jbrowse-components/blob/v2.10.1/products/jbrowse-cli/src/commands/create.ts)_
459
+ [src/commands/create.ts](https://github.com/GMOD/jbrowse-components/blob/v2.10.2/products/jbrowse-cli/src/commands/create.ts)_
460
460
 
461
461
  ## `jbrowse help [COMMANDS]`
462
462
 
@@ -507,7 +507,7 @@ EXAMPLES
507
507
  ```
508
508
 
509
509
  _See code:
510
- [src/commands/make-pif.ts](https://github.com/GMOD/jbrowse-components/blob/v2.10.1/products/jbrowse-cli/src/commands/make-pif.ts)_
510
+ [src/commands/make-pif.ts](https://github.com/GMOD/jbrowse-components/blob/v2.10.2/products/jbrowse-cli/src/commands/make-pif.ts)_
511
511
 
512
512
  ## `jbrowse remove-track TRACK`
513
513
 
@@ -535,7 +535,7 @@ EXAMPLES
535
535
  ```
536
536
 
537
537
  _See code:
538
- [src/commands/remove-track.ts](https://github.com/GMOD/jbrowse-components/blob/v2.10.1/products/jbrowse-cli/src/commands/remove-track.ts)_
538
+ [src/commands/remove-track.ts](https://github.com/GMOD/jbrowse-components/blob/v2.10.2/products/jbrowse-cli/src/commands/remove-track.ts)_
539
539
 
540
540
  ## `jbrowse set-default-session`
541
541
 
@@ -543,22 +543,16 @@ Set a default session with views and tracks
543
543
 
544
544
  ```
545
545
  USAGE
546
- $ jbrowse set-default-session [-s <value>] [-n <value>] [-v <value>] [--viewId <value>] [-t <value>] [-c] [--target
547
- <value>] [--out <value>] [--delete] [-h]
546
+ $ jbrowse set-default-session [-s <value>] [-n <value>] [-c] [--target <value>] [--out <value>] [--delete] [-h]
548
547
 
549
548
  FLAGS
550
549
  -c, --currentSession List out the current default session
551
550
  -h, --help Show CLI help.
552
551
  -n, --name=<value> [default: New Default Session] Give a name for the default session
553
552
  -s, --session=<value> set path to a file containing session in json format
554
- -t, --tracks=<value> Track id or track ids as comma separated string to put into default session
555
- -v, --view=<value> View type in config to be added as default session, i.e LinearGenomeView, CircularView,
556
- DotplotView.
557
- Must be provided if no default session file provided
558
553
  --delete Delete any existing default session.
559
554
  --out=<value> synonym for target
560
555
  --target=<value> path to config file in JB2 installation directory to write out to
561
- --viewId=<value> Identifier for the view. Will be generated on default
562
556
 
563
557
  DESCRIPTION
564
558
  Set a default session with views and tracks
@@ -566,15 +560,15 @@ DESCRIPTION
566
560
  EXAMPLES
567
561
  $ jbrowse set-default-session --session /path/to/default/session.json
568
562
 
569
- $ jbrowse set-default-session --target /path/to/jb2/installation/config.json --view LinearGenomeView --tracks track1, track2, track3
563
+ $ jbrowse set-default-session --target /path/to/jb2/installation/config.json
570
564
 
571
- $ jbrowse set-default-session --view LinearGenomeView, --name newName --viewId view-no-tracks
565
+ $ jbrowse set-default-session --view LinearGenomeView, --name newName
572
566
 
573
567
  $ jbrowse set-default-session --currentSession # Prints out current default session
574
568
  ```
575
569
 
576
570
  _See code:
577
- [src/commands/set-default-session.ts](https://github.com/GMOD/jbrowse-components/blob/v2.10.1/products/jbrowse-cli/src/commands/set-default-session.ts)_
571
+ [src/commands/set-default-session.ts](https://github.com/GMOD/jbrowse-components/blob/v2.10.2/products/jbrowse-cli/src/commands/set-default-session.ts)_
578
572
 
579
573
  ## `jbrowse sort-gff FILE`
580
574
 
@@ -605,7 +599,7 @@ EXAMPLES
605
599
  ```
606
600
 
607
601
  _See code:
608
- [src/commands/sort-gff.ts](https://github.com/GMOD/jbrowse-components/blob/v2.10.1/products/jbrowse-cli/src/commands/sort-gff.ts)_
602
+ [src/commands/sort-gff.ts](https://github.com/GMOD/jbrowse-components/blob/v2.10.2/products/jbrowse-cli/src/commands/sort-gff.ts)_
609
603
 
610
604
  ## `jbrowse text-index`
611
605
 
@@ -672,7 +666,7 @@ EXAMPLES
672
666
  ```
673
667
 
674
668
  _See code:
675
- [src/commands/text-index.ts](https://github.com/GMOD/jbrowse-components/blob/v2.10.1/products/jbrowse-cli/src/commands/text-index.ts)_
669
+ [src/commands/text-index.ts](https://github.com/GMOD/jbrowse-components/blob/v2.10.2/products/jbrowse-cli/src/commands/text-index.ts)_
676
670
 
677
671
  ## `jbrowse upgrade [LOCALPATH]`
678
672
 
@@ -735,7 +729,7 @@ EXAMPLES
735
729
  ```
736
730
 
737
731
  _See code:
738
- [src/commands/upgrade.ts](https://github.com/GMOD/jbrowse-components/blob/v2.10.1/products/jbrowse-cli/src/commands/upgrade.ts)_
732
+ [src/commands/upgrade.ts](https://github.com/GMOD/jbrowse-components/blob/v2.10.2/products/jbrowse-cli/src/commands/upgrade.ts)_
739
733
 
740
734
  <!-- commandsstop -->
741
735
 
package/lib/base.js CHANGED
@@ -139,8 +139,7 @@ class JBrowseCommand extends core_1.Command {
139
139
  const response = await (0, fetchWithProxy_1.default)(`https://api.github.com/repos/GMOD/jbrowse-components/releases/tags/${tag}`);
140
140
  if (response.ok) {
141
141
  const result = (await response.json());
142
- const file = result?.assets?.find(f => f.name.includes('jbrowse-web'))
143
- ?.browser_download_url;
142
+ const file = result?.assets?.find(f => f.name.includes('jbrowse-web'))?.browser_download_url;
144
143
  if (!file) {
145
144
  this.error('Could not find version specified. Use --listVersions to see all available versions', { exit: 90 });
146
145
  }
@@ -11,70 +11,28 @@ const fsPromises = fs_1.default.promises;
11
11
  class SetDefaultSession extends base_1.default {
12
12
  async run() {
13
13
  const { flags: runFlags } = await this.parse(SetDefaultSession);
14
- const { session, name, tracks, currentSession, view, viewId, delete: deleteDefaultSession, } = runFlags;
14
+ const { session, currentSession, delete: deleteDefaultSession } = runFlags;
15
15
  const output = runFlags.target || runFlags.out || '.';
16
16
  const isDir = (await fsPromises.lstat(output)).isDirectory();
17
17
  this.target = isDir ? `${output}/config.json` : output;
18
18
  const configContents = await this.readJsonFile(this.target);
19
19
  if (deleteDefaultSession) {
20
20
  delete configContents.defaultSession;
21
- this.debug(`Writing configuration to file ${this.target}`);
22
21
  await this.writeJsonFile(this.target, configContents);
23
- this.log(`Deleted defaultSession from ${this.target}`);
24
- return;
25
22
  }
26
- // if user passes current session flag, print out and exit
27
- if (currentSession) {
23
+ else if (currentSession) {
28
24
  this.log(`The current default session is ${JSON.stringify(configContents.defaultSession)}`);
29
25
  this.exit();
30
26
  }
31
- const foundTracks = [];
32
- const existingDefaultSession = configContents.defaultSession?.length > 0;
33
- // must provide default session, or view, or tracks + view
34
- if (!session && !view && !tracks) {
35
- this.error(`No default session information provided, Please either provide a default session file or enter information to build a default session`, { exit: 120 });
27
+ else if (!session) {
28
+ this.error(`Please either provide a default session file`, { exit: 120 });
36
29
  }
37
30
  else if (session) {
38
- // if user provides a file, process and set as default session and exit
39
- const defaultJson = await this.readDefaultSessionFile(session);
40
- configContents.defaultSession = defaultJson;
41
- }
42
- else {
43
- // use trackids if any to match to tracks in the config
44
- let trackIds = [];
45
- if (tracks && configContents.tracks) {
46
- if (!view) {
47
- this.error('Tracks must have a view type specified. Please rerun using the --view flag', { exit: 130 });
48
- }
49
- trackIds = tracks.split(',').map(c => c.trim());
50
- trackIds.forEach(trackId => {
51
- this.log(trackId);
52
- const matchingTrack = configContents.tracks?.find(track => trackId === track.trackId);
53
- if (!matchingTrack) {
54
- this.error(`Track ${trackId} has not been added to config yet.\nPlease add the track with the add-track command before adding to the default session`, { exit: 140 });
55
- }
56
- else {
57
- foundTracks.push({
58
- type: matchingTrack.type,
59
- configuration: matchingTrack.trackId,
60
- });
61
- }
62
- });
63
- }
64
- configContents.defaultSession = {
65
- name,
66
- views: [
67
- {
68
- id: viewId || `${view}-${foundTracks.length}`,
69
- type: view,
70
- tracks: foundTracks,
71
- },
72
- ],
73
- };
31
+ await this.writeJsonFile(this.target, {
32
+ ...configContents,
33
+ defaultSession: await this.readDefaultSessionFile(session),
34
+ });
74
35
  }
75
- this.debug(`Writing configuration to file ${this.target}`);
76
- await this.writeJsonFile(this.target, configContents);
77
- this.log(`${existingDefaultSession ? 'Overwrote' : 'Added'} defaultSession "${name}" ${existingDefaultSession ? 'in' : 'to'} ${this.target}`);
78
36
  }
79
37
  async readDefaultSessionFile(defaultSessionFile) {
80
38
  let defaultSessionJson;
@@ -102,8 +60,8 @@ class SetDefaultSession extends base_1.default {
102
60
  SetDefaultSession.description = 'Set a default session with views and tracks';
103
61
  SetDefaultSession.examples = [
104
62
  '$ jbrowse set-default-session --session /path/to/default/session.json',
105
- '$ jbrowse set-default-session --target /path/to/jb2/installation/config.json --view LinearGenomeView --tracks track1, track2, track3',
106
- '$ jbrowse set-default-session --view LinearGenomeView, --name newName --viewId view-no-tracks',
63
+ '$ jbrowse set-default-session --target /path/to/jb2/installation/config.json',
64
+ '$ jbrowse set-default-session --view LinearGenomeView, --name newName',
107
65
  '$ jbrowse set-default-session --currentSession # Prints out current default session',
108
66
  ];
109
67
  SetDefaultSession.flags = {
@@ -116,17 +74,6 @@ SetDefaultSession.flags = {
116
74
  description: 'Give a name for the default session',
117
75
  default: 'New Default Session',
118
76
  }),
119
- view: core_1.Flags.string({
120
- char: 'v',
121
- description: 'View type in config to be added as default session, i.e LinearGenomeView, CircularView, DotplotView.\nMust be provided if no default session file provided',
122
- }),
123
- viewId: core_1.Flags.string({
124
- description: 'Identifier for the view. Will be generated on default',
125
- }),
126
- tracks: core_1.Flags.string({
127
- char: 't',
128
- description: 'Track id or track ids as comma separated string to put into default session',
129
- }),
130
77
  currentSession: core_1.Flags.boolean({
131
78
  char: 'c',
132
79
  description: 'List out the current default session',
@@ -784,8 +784,8 @@
784
784
  "description": "Set a default session with views and tracks",
785
785
  "examples": [
786
786
  "$ jbrowse set-default-session --session /path/to/default/session.json",
787
- "$ jbrowse set-default-session --target /path/to/jb2/installation/config.json --view LinearGenomeView --tracks track1, track2, track3",
788
- "$ jbrowse set-default-session --view LinearGenomeView, --name newName --viewId view-no-tracks",
787
+ "$ jbrowse set-default-session --target /path/to/jb2/installation/config.json",
788
+ "$ jbrowse set-default-session --view LinearGenomeView, --name newName",
789
789
  "$ jbrowse set-default-session --currentSession # Prints out current default session"
790
790
  ],
791
791
  "flags": {
@@ -806,29 +806,6 @@
806
806
  "multiple": false,
807
807
  "type": "option"
808
808
  },
809
- "view": {
810
- "char": "v",
811
- "description": "View type in config to be added as default session, i.e LinearGenomeView, CircularView, DotplotView.\nMust be provided if no default session file provided",
812
- "name": "view",
813
- "hasDynamicHelp": false,
814
- "multiple": false,
815
- "type": "option"
816
- },
817
- "viewId": {
818
- "description": "Identifier for the view. Will be generated on default",
819
- "name": "viewId",
820
- "hasDynamicHelp": false,
821
- "multiple": false,
822
- "type": "option"
823
- },
824
- "tracks": {
825
- "char": "t",
826
- "description": "Track id or track ids as comma separated string to put into default session",
827
- "name": "tracks",
828
- "hasDynamicHelp": false,
829
- "multiple": false,
830
- "type": "option"
831
- },
832
809
  "currentSession": {
833
810
  "char": "c",
834
811
  "description": "List out the current default session",
@@ -1146,5 +1123,5 @@
1146
1123
  ]
1147
1124
  }
1148
1125
  },
1149
- "version": "2.10.1"
1126
+ "version": "2.10.2"
1150
1127
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jbrowse/cli",
3
- "version": "2.10.1",
3
+ "version": "2.10.2",
4
4
  "description": "A command line tool for working with JBrowse 2",
5
5
  "keywords": [
6
6
  "jbrowse",
@@ -75,5 +75,5 @@
75
75
  "publishConfig": {
76
76
  "access": "public"
77
77
  },
78
- "gitHead": "442b5f87efddfdf4ccf520b4d9dd01ddd370cb07"
78
+ "gitHead": "7ca3b7db337ebd88853e2d96cdab940ed550c4fb"
79
79
  }