cli's Introduction

OpenSumi CLI

🛠️ Standard Tooling for OpenSumi Extensions Development

Develop

$ yarn
$ yarn dev

Test command on the local:

$ ./packages/cli/bin/sumi.js <command> [options]

Publish

$ yarn release

Then push commits and tag to the main branch, the @opensumi/cli@{tag_version} will release automatically.

Usage

Install @opensumi/cli:

$ npm install @opensumi/cli -g

Initailize the template:

$ sumi init opensumi-ext-demo
$ cd opensumi-ext-demo
$ npm run watch
$ sumi dev

Commands

Usage: sumi <command> [options]

Options:
  -V, --version                                          output the version number
  -h, --help                                             output usage information

Commands:
  init                                                   init a new extension powered by OpenSumi
  watch                                                  watch extension in development mode
  dev [options]                                          launch OpenSumi IDE load specified extension.
  compile                                                compile extension in production mode
  package [options]                                      Packages an extension
  install <publisher> <name> <version> [extensionDir]    installing a extension
  engine                                                 OpenSumi cli engine management
    add <version>                                        download and install a [version]
    remove <version>                                     remove specific [version] engine
    use  <version>                                       change current engine to [version]
    ls                                                   list installed engine versions
    ls-remote                                            list remote engine versions available for install
    current                                              display currently selected version

Run sumi <command> --help for detailed usage of given command.

Use the specified OpenSumi version

List the remote engine version

$ sumi engine ls-remote

2.22.10-rc-1679037411.0   rc
              -> 2.23.0   latest

Add expected version

$ sumi engine add 2.23.0

License

Licensed under the MIT license.

cli's People

Contributors

Watchers

cli's Issues

cli生成的配置引入第三方库貌似有点问题

应该是没配置js文件的loader，但是我使用自定义webpack配置后也是一直报错

sumi.config.js

const path = require("path");
const {
  browser,
} = require("@opensumi/cli/lib/config/webpack/shared.webpack.config");

const root = path.join(__dirname);

module.exports.browser = browser({
  mode: "production",
  context: path.join(process.cwd()),
  target: 'web',
  entry: {
    "SUMI-BROWSER": path.join(root, "src/extend/browser/index.ts"),
  },
  output: {
    filename: "browserExtension.js",
    path: path.join(__dirname, "dist"),
    libraryTarget: "commonjs",
  },
  module: {
    rules: [
      {
        test: /\.(m|j)s$/,
        loader: "babel-loader",
        options: {},
      },
      {
        test: /\.tsx?$/,
        exclude: /node_modules/,
        use: [
          {
            loader: require.resolve("ts-loader"),
            options: {
              compilerOptions: {
                sourceMap: false,
              },
            },
          },
        ],
      },
      {
        test: /\.less$/,
        use: [
          require.resolve("style-loader"),
          require.resolve("css-loader"),
          {
            loader: require.resolve("less-loader"),
            options: {
              lessOptions: {
                javascriptEnabled: true,
              },
            },
          },
        ],
      },
      {
        test: /\.css$/,
        use: [require.resolve("style-loader"), require.resolve("css-loader")],
      },
      {
        test: /\.(woff(2)?|ttf|eot|svg)(\?v=\d+\.\d+\.\d+)?$/,
        use: [
          {
            loader: require.resolve("file-loader"),
            options: {
              name: "[name].[ext]",
              outputPath: "fonts/",
            },
          },
        ],
      },
    ],
  },
  
  // resolve: {
  //   fallback: {
  //     dgram: false,
  //     fs: false,
  //     net: false,
  //     tls: false,
  //   },
  // },
  externals: {
    react: "React",
    "react-dom": "ReactDOM",
  },
});