This is the example project used for the Mike Works Visual Studio Code course.
Course outline and slides
About This Workshop
Visual Studio Code is a modern, lightweight and full-featured code editor, built from the ground up to suit the needs of web developers, and JavaScript developers in particular. In this course, we'll dive deep into using, customizing and extending it.
What will we do?
We’ll begin by taking a look at how we can get this fantastic tool to do as much heavy lifting for us as possible. Recent improvements have perfected the ability to attach directly to browsers and Node.js for a truly excellent debugging experience.
If you spend all day looking at and manipulating code, you may as well have your settings exactly the way you want them. We’ll go deep into customizations that’ll affect embedded feedback from static code analysis, the look and feel of the editor and study a few of the best and most useful extensions.
Because VS Code is built with web technology, it’s easy for JavaScript and TypeScript developers to customize and extend. We’ll build two extensions of our own, unlocking extra productivity when working on common tasks.
By coding along with this two day (split into four half-days) workshop, you will:
- Get hands on experience with debugging in a variety of scenarios
- Learn how to use launch configurations to execute programs run shell scripts
- Unlock extra productivity by consolidating your terminal, debugger and editor into one tool
- Learn about deep customization options that make a REAL difference in how you get your work done
- Get a tour of plugins so powerful, after using them you’ll wonder how you ever lived without them!
- Build your own “code snippet” extension And more…
Setup
Please make sure you have the following software installed before arriving at the workshop or beginning the course.
General Packages
Please make sure you have the following general software installed
| Required | Library | Version Range | Notes |
|---|---|---|---|
| ✔ | Node.js | >= 8.0 | nvm is highly recommended for managing multiple node versions on a single machine |
| ✔ | Visual Studio Code | >= 1.14 | We'll be using several specific features of the VS Code editor. We can't force you to use it, but you'll miss out if you don't! |
| ✔ | Yarn | >= 0.24 | An alternative to npm (if you are using nvm: brew install yarn --without-node, else use brew install yarn) |
| ✔ | SQLite | >= 3 | An embedded relational database (hint: brew install sqlite3) |
VS Code Extensions
Additionally, to take advantage of syntax hilighting, static code analysis and other editor features, you'll want to install the latest version of the following VS Code extensions
| Required | Extension | Notes |
|---|---|---|
| ✔ | sass-indented | Syntax highlighting and code completion support for Sass stylesheets |
| ✔ | eslint | Static code analysis for JavaScript and JSX files |
| ✔ | jest | Syntax highlighting for Jest snapshot testing and in-editor test pass/fail statuses |
| ✔ | Debugger for Chrome | Allows us to attach to Chrome for debugging |
| vscode-icons | Better file and folder icons | |
| rest-client | An in-editor REST client, so we can experiment with our API effortlessly |
Global Node.js Packages
Make sure you have these npm packages installed globally. This can be done by running
npm install -g <package-name>| Required | Library | Version Range |
|---|---|---|
| ✔ | babel-eslint | ^7.0.0 |
| ✔ | eslint | ^4.0.0 |
| ✔ | eslint-plugin-babel | ^4.0.0 |
| ✔ | eslint-plugin-react | ^7.1.0 |
Project setup
First, clone this project from Github
git clone https://github.com/mike-works/vscode-fundamentals vscode
cd vscodeFinally, while in the top-level folder of this project, download the and install this project's dependencies by running
yarnTo start the app, run
npm startand you should see something on http://localhost:3000
Troubleshooting
What if I have an older version of Node.js?
You may run into problems during the workshop! An easy way to deal with this is to...
- install nvm by running
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.4/install.sh | bashor Wget:
wget -qO- https://raw.githubusercontent.com/creationix/nvm/v0.33.4/install.sh | bash- then restart your terminal
- then run
nvm install stable nvm use stable nvm alias default stable
What if I get an error like Please install sqlite3 package manually?
If you use OS X, it can be installed with homebew
brew install sqlite3Windows and Linux users, please install the appropriate official release.
Files and Folders
This is a free-standing client/server system, including
- A database
- A REST API
- A single-page-app web client
Project
│
├─ client/ 📱 React web client
│ ├─ components/ 📊 React components
│ │ │
│ │ ├─ my-thing/index.jsx Component implementation
│ │ ├─ my-thing/index.test.js Component tests
│ │ └─ my-thing/styles.scss Component styles
│ │
│ ├─ routes/ 🔝 Top-level React components, each corresponding to a "page" in our app
│ ├─ sass/ 💅 Global Sass stylesheets
│ ├─ app.jsx 🎁 React "App" component
│ ├─ index.js 🎬 Web client entry point
│ └─ index.ejs 📄 Template for web client index.html
│
├─ db/ 💾 SQLite databases
├─ dist/ 📦 Web client development/production builds
├─ server/ 🛒 Node.js API to support the web client
├─ webpack/ ⚙️ Build configuration
└─ .vapid.json 🔐 VAPID private and public keysWhat are the pieces?
- Webpack 3
- Babel 7.x, setup with the babel-preset-env plugins, compiling to ES5 JavaScript
- TSLint for linting TypeScript
- sass-loader for traditional management of Sass styles
- extract-text-webpack-plugin so compiled styles are external stylesheets instead of inline style blocks
- React as a component library
- MUI as a lightweight (6.6K) Material Design inspired UI kit
- Jest as a testing platform
- SQLite3 - as a lightweight, embedded database (for API)
- Koa - as a HTTP server for our API.
License
While the general license for this project is the BSD 3-clause, the exercises themselves are proprietary and are licensed on a per-individual basis, usually as a result of purchasing a ticket to a public workshop, or being a participant in a private training.
Here are some guidelines for things that are OK and NOT OK, based on our understanding of how these licenses work:
OK
- Using everything in this project other than the exercises (or accompanying tests) to build a project used for your own free or commercial training material
- Copying code from build scripts, configuration files, tests and development harnesses that are not part of the exercises specifically, for your own projects
- As an owner of an individual license, using code from tests, exercises, or exercise solutions for your own non-training-related project.
NOT OK (without express written consent)
- Using this project, or any subset of exercises contained within this project to run your own workshops
- Writing a book that uses the code for these exercises
- Recording a screencast that contains one or more of this project's exercises
Copyright
© 2018 Mike Works, Inc., All Rights Reserved