Method getPackages

src/helpViewer/packages.ts:243–273

(fromCran: boolean = false)

    }

    public async getPackages(fromCran: boolean = false): Promise<Package[]|undefined> {
        let packages: Package[]|undefined;
        this.pullFavoriteNames();
        if(fromCran){
            // Use a placeholder, since multiple different urls are attempted
            const CRAN_PATH_PLACEHOLDER = 'CRAN_PATH_PLACEHOLDER';

            packages = this.getCachedIndexFile(CRAN_PATH_PLACEHOLDER);
            if(!packages?.length){
                const cranUrl = await getCranUrl('', this.cwd);
                packages = await getPackagesFromCran(cranUrl);
                await this.updateCachedIndexFile(CRAN_PATH_PLACEHOLDER, packages);
            }
        } else{
            packages = await this.getParsedIndexFile(`/doc/html/packages.html`);
            if(!packages?.length){
                void vscode.window.showErrorMessage('Help provider not available!');
            }
        }
        if(packages){
            for(const pkg of packages){
                pkg.isFavorite = this.favoriteNames.has(pkg.name);
                pkg.helpPath = (
                    pkg.name === 'doc' ?
                        '/doc/html/packages.html' :
                        `/library/${pkg.name}/html/00Index.html`
                );
            }
        }
        return packages;
    }


    // parses a package's index file to produce a list of help topics