@tarojs/cli

  • Version 3.6.7
  • Published
  • 491 kB
  • 24 dependencies
  • MIT license

Install

npm i @tarojs/cli
yarn add @tarojs/cli
pnpm add @tarojs/cli

Overview

cli tool for taro

Index

Variables

variable default

const default: {
doctor: {
validators: (
| (({
configPath,
projectConfig,
}: {
configPath: any;
projectConfig: any;
}) => Promise<{ desc: string; lines: any }>)
| (({
appPath,
}: {
appPath: any;
}) => Promise<{ desc: string; lines: ErrorLine[] }>)
| (({
projectConfig,
}: {
projectConfig: any;
}) => Promise<{ desc: string; raw: any }>)
)[];
};
Project: typeof Project;
Creator: typeof Creator;
};

    variable doctor

    const doctor: {
    validators: (
    | (({
    configPath,
    projectConfig,
    }: {
    configPath: any;
    projectConfig: any;
    }) => Promise<{ desc: string; lines: any }>)
    | (({
    appPath,
    }: {
    appPath: any;
    }) => Promise<{ desc: string; lines: ErrorLine[] }>)
    | (({
    projectConfig,
    }: {
    projectConfig: any;
    }) => Promise<{ desc: string; raw: any }>)
    )[];
    };

      Classes

      class Creator

      class Creator {}

        constructor

        constructor(sourceRoot?: string);

          property fs

          fs: IMemFsEditor;

            method destinationPath

            destinationPath: (...args: string[]) => string;

              method destinationRoot

              destinationRoot: (rootPath?: string) => string;

                method init

                init: () => void;

                  method sourceRoot

                  sourceRoot: (rootPath?: string) => string;

                    method template

                    template: (
                    template: string,
                    source: string,
                    dest: string,
                    data?: Record<any, any>,
                    options?: any
                    ) => this;

                      method templatePath

                      templatePath: (...args: string[]) => string;

                        method write

                        write: () => void;

                          method writeGitKeepFile

                          writeGitKeepFile: (dirname: string) => void;

                            class Project

                            class Project extends Creator {}

                              constructor

                              constructor(options: IProjectConf);

                                property askCompiler

                                askCompiler: AskMethods;

                                  property askCSS

                                  askCSS: AskMethods;

                                    property askDescription

                                    askDescription: AskMethods;

                                      property askFramework

                                      askFramework: AskMethods;

                                        property askNpm

                                        askNpm: AskMethods;

                                          property askProjectName

                                          askProjectName: AskMethods;

                                            property askTemplate

                                            askTemplate: AskMethods;

                                              property askTemplateSource

                                              askTemplateSource: AskMethods;

                                                property askTypescript

                                                askTypescript: AskMethods;

                                                  property conf

                                                  conf: IProjectConf;

                                                    property rootPath

                                                    rootPath: string;

                                                      method ask

                                                      ask: () => Promise<any>;

                                                        method create

                                                        create: () => Promise<void>;

                                                          method fetchTemplates

                                                          fetchTemplates: (answers: any) => Promise<ITemplates[]>;

                                                            method init

                                                            init: () => void;

                                                              method write

                                                              write: (cb?: () => void) => void;

                                                                Namespaces

                                                                namespace @tarojs/components

                                                                module '@tarojs/components' {}

                                                                  namespace *.css

                                                                  module '*.css' {}

                                                                    namespace *.gif

                                                                    module '*.gif' {}

                                                                      namespace *.jpeg

                                                                      module '*.jpeg' {}

                                                                        namespace *.jpg

                                                                        module '*.jpg' {}

                                                                          namespace *.json

                                                                          module '*.json' {}

                                                                            variable value

                                                                            const value: any;

                                                                              namespace *.less

                                                                              module '*.less' {}

                                                                                namespace *.png

                                                                                module '*.png' {}

                                                                                  namespace *.sass

                                                                                  module '*.sass' {}

                                                                                    namespace *.scss

                                                                                    module '*.scss' {}

                                                                                      namespace *.styl

                                                                                      module '*.styl' {}

                                                                                        namespace *.svg

                                                                                        module '*.svg' {}

                                                                                          Package Files (6)

                                                                                          Dependencies (24)

                                                                                          Dev Dependencies (6)

                                                                                          Peer Dependencies (0)

                                                                                          No peer dependencies.

                                                                                          Badge

                                                                                          To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                                          You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@tarojs/cli.

                                                                                          • Markdown
                                                                                            [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@tarojs/cli)
                                                                                          • HTML
                                                                                            <a href="https://www.jsdocs.io/package/@tarojs/cli"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>