Git Product home page Git Product logo

generator-azuredatastudio's Introduction

Azure Data Studio - Extension Generator

Twitter Follow

The Azure Data Studio Extension Generator is a Yeoman-based generator to help get you started with authoring extensions. There are 13 different possible templates for you to use.

Install the Generator

Ensure that you have Node.js and npm installed.

Install Yeoman and the Azure Data Studio Extension generator by using the following command:

npm install -g yo generator-azuredatastudio

Running the Generator

To launch the generator type:

yo azuredatastudio

The extension generator will walk you through the steps required to create your customized extension with prompting for any required information.

The command generator

To learn more about extension authoring, there are a few resources you can view. For an overview on the extension authoring process, see Extension authoring. For a tutorial using the Extension Generator to create an extension, view Create an extension.

Generator Output

These templates will:

  • Create a base folder structure with extension-specific files
  • Template out a rough package.json using your answers from the provided prompts
  • Import any assets required for your extension e.g. tmBundles or the VS Code Library
  • For Extensions: Set-up launch.json for running your extension and attaching to a process
  • Document how to get started in a vsc-extension-quickstart.md file

History

  • 0.11.x: Added dashboard, notebook, Jupyter Book, and wizards/dialogues templates.
  • 0.10.x: Generates a Azure Data Studio extension for TypeScript 1.8.10

License

MIT

generator-azuredatastudio's People

Contributors

alanrenmsft avatar charles-gagnon avatar dependabot[bot] avatar microsoft-github-operations[bot] avatar microsoftopensource avatar

Stargazers

avatar avatar

Watchers

avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar

Forkers

standardgalactic test-mass-forker-org-1

generator-azuredatastudio's Issues

Deprecated?

Hello there,

is this repo deprecated/abandoned in some way?

I found it when reading through the Azure Data Studio Docs.
Unfortunately the latest version has several security bugs through outdated dependencies and also trying to generate a Jupyter Book as described in the docs results in an Error.

# npm audit report

ejs  <3.1.7
Severity: critical
ejs template injection vulnerability - https://github.com/advisories/GHSA-phwq-j96m-2c2q
fix available via `npm audit fix --force`
Will install [email protected], which is a breaking change
node_modules/yeoman-environment/node_modules/ejs
  mem-fs-editor  2.0.0 - 6.0.0 || 7.0.1 - 7.1.0
  Depends on vulnerable versions of ejs
  Depends on vulnerable versions of globby
  node_modules/mem-fs-editor
  node_modules/yeoman-environment/node_modules/mem-fs-editor
    yeoman-environment  2.1.0 - 2.10.3
    Depends on vulnerable versions of globby
    Depends on vulnerable versions of mem-fs-editor
    node_modules/yeoman-environment
      yeoman-generator  0.20.0 - 4.13.0
      Depends on vulnerable versions of github-username
      Depends on vulnerable versions of mem-fs-editor
      Depends on vulnerable versions of yeoman-environment
      node_modules/yeoman-generator
        generator-azuredatastudio  >=0.14.0
        Depends on vulnerable versions of yeoman-generator
        node_modules/generator-azuredatastudio

glob-parent  <5.1.2
Severity: high
glob-parent before 5.1.2 vulnerable to Regular Expression Denial of Service in enclosure regex - https://github.com/advisories/GHSA-ww39-953v-wcq6
fix available via `npm audit fix --force`
Will install [email protected], which is a breaking change
node_modules/glob-parent
  fast-glob  <=2.2.7
  Depends on vulnerable versions of glob-parent
  node_modules/fast-glob
    globby  8.0.0 - 9.2.0
    Depends on vulnerable versions of fast-glob

? Do you have existing notebooks you would like to create a Jupyter Book out of? No
node:events:491
      throw er; // Unhandled 'error' event
      ^

Error: ENOENT: no such file or directory, scandir 'C:\Users\magoerlich\source\repos\azds-jupyter-book-ext\node_modules\generator-azuredatastudio\generators\app\templates\ext-jupyterbook\_data\toc.yml'
    at Object.readdirSync (node:fs:1450:3)
    at exports.readdir (C:\Users\magoerlich\source\repos\azds-jupyter-book-ext\node_modules\@mrmlnc\readdir-enhanced\lib\sync\fs.js:18:20)
    at Object.safeCall [as safe] (C:\Users\magoerlich\source\repos\azds-jupyter-book-ext\node_modules\@mrmlnc\readdir-enhanced\lib\call.js:24:8)
    at DirectoryReader.readNextDirectory (C:\Users\magoerlich\source\repos\azds-jupyter-book-ext\node_modules\@mrmlnc\readdir-enhanced\lib\directory-reader.js:78:10)
    at DirectoryReader.stream._read (C:\Users\magoerlich\source\repos\azds-jupyter-book-ext\node_modules\@mrmlnc\readdir-enhanced\lib\directory-reader.js:57:18)
    at Readable.read (node:internal/streams/readable:496:12)
    at readdirSync (C:\Users\magoerlich\source\repos\azds-jupyter-book-ext\node_modules\@mrmlnc\readdir-enhanced\lib\sync\index.js:27:21)
    at Function.readdirSyncStat (C:\Users\magoerlich\source\repos\azds-jupyter-book-ext\node_modules\@mrmlnc\readdir-enhanced\lib\index.js:34:10)
    at ReaderSync.dynamicApi (C:\Users\magoerlich\source\repos\azds-jupyter-book-ext\node_modules\fast-glob\out\providers\reader-sync.js:64:24)
    at ReaderSync.api (C:\Users\magoerlich\source\repos\azds-jupyter-book-ext\node_modules\fast-glob\out\providers\reader-sync.js:56:25)
Emitted 'error' event on Readable instance at:
    at emitErrorNT (node:internal/streams/destroy:151:8)
    at emitErrorCloseNT (node:internal/streams/destroy:116:3)
    at process.processTicksAndRejections (node:internal/process/task_queues:82:21) {
  errno: -4058,
  syscall: 'scandir',
  code: 'ENOENT',
  path: 'C:\\Users\\magoerlich\\source\\repos\\azds-jupyter-book-ext\\node_modules\\generator-azuredatastudio\\generators\\app\\templates\\ext-jupyterbook\\_data\\toc.yml'
}

The latest release on NPM and the latest tag here on GH are ~1yr old.
But the master branch still has recent commits....are there any plans on releasing them?

Or is there a more up to date way of doing this?

Thanks, Manuel

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.