prettier 1.5.4 → 2.0.0.pre.rc1

data/src/haml/nodes/tag.js

@@ -1,193 +0,0 @@
-const {
-  align,
-  concat,
-  fill,
-  group,
-  hardline,
-  ifBreak,
-  indent,
-  join,
-  line,
-  softline
-} = require("../../prettier");
-
-function getDynamicAttributes(header, attributes) {
-  const pairs = attributes
-    .slice(1, -2)
-    .split(",")
-    .map((pair) => pair.slice(1).split('" => '));
-
-  const parts = [concat([pairs[0][0], "=", pairs[0][1]])];
-  pairs.slice(1).forEach((pair) => {
-    parts.push(line, concat([pair[0], "=", pair[1]]));
-  });
-
-  return group(concat(["(", align(header + 1, fill(parts)), ")"]));
-}
-
-function getHashValue(value, opts) {
-  if (typeof value !== "string") {
-    return value.toString();
-  }
-
-  // This is a very special syntax created by the parser to let us know that
-  // this should be printed literally instead of as a string.
-  if (value.startsWith("&")) {
-    return value.slice(1);
-  }
-
-  const quote = opts.rubySingleQuote ? "'" : '"';
-  return `${quote}${value}${quote}`;
-}
-
-function getHashKey(key, opts) {
-  let quoted = key;
-  const joiner = opts.rubyHashLabel ? ":" : " =>";
-
-  if (key.includes(":") || key.includes("-")) {
-    const quote = opts.rubySingleQuote ? "'" : '"';
-    quoted = `${quote}${key}${quote}`;
-  }
-
-  return `${opts.rubyHashLabel ? "" : ":"}${quoted}${joiner}`;
-}
-
-function getKeyValuePair(key, value, opts) {
-  return `${getHashKey(key, opts)} ${getHashValue(value, opts)}`;
-}
-
-function getStaticAttributes(header, attributes, opts) {
-  const keys = Object.keys(attributes).filter(
-    (name) => !["class", "id"].includes(name)
-  );
-
-  const parts = [getKeyValuePair(keys[0], attributes[keys[0]], opts)];
-
-  keys.slice(1).forEach((key) => {
-    parts.push(",", line, getKeyValuePair(key, attributes[key], opts));
-  });
-
-  return group(concat(["{", align(header + 1, fill(parts)), "}"]));
-}
-
-function getAttributesObject(object, opts, level = 0) {
-  if (typeof object !== "object") {
-    return getHashValue(object, opts);
-  }
-
-  const boundary = level === 0 ? softline : line;
-  const parts = Object.keys(object).map((key) =>
-    concat([
-      getHashKey(key, opts),
-      " ",
-      getAttributesObject(object[key], opts, level + 1)
-    ])
-  );
-
-  return group(
-    concat([
-      "{",
-      indent(group(concat([boundary, join(concat([",", line]), parts)]))),
-      boundary,
-      "}"
-    ])
-  );
-}
-
-function getHeader(value, opts) {
-  const { attributes } = value;
-  const parts = [];
-
-  if (value.name !== "div") {
-    parts.push(`%${value.name}`);
-  }
-
-  if (attributes.class) {
-    parts.push(`.${attributes.class.replace(/ /g, ".")}`);
-  }
-
-  if (attributes.id) {
-    parts.push(`#${attributes.id}`);
-  }
-
-  if (value.dynamic_attributes.new) {
-    parts.push(
-      getDynamicAttributes(parts.join("").length, value.dynamic_attributes.new)
-    );
-  }
-
-  if (
-    Object.keys(attributes).some((name) => name !== "class" && name !== "id")
-  ) {
-    parts.push(getStaticAttributes(parts.join("").length, attributes, opts));
-  }
-
-  if (value.dynamic_attributes.old) {
-    if (parts.length === 0) {
-      parts.push("%div");
-    }
-
-    if (typeof value.dynamic_attributes.old === "string") {
-      parts.push(value.dynamic_attributes.old);
-    } else {
-      parts.push(getAttributesObject(value.dynamic_attributes.old, opts));
-    }
-  }
-
-  if (value.object_ref) {
-    if (parts.length === 0) {
-      parts.push("%div");
-    }
-    parts.push(value.object_ref);
-  }
-
-  if (value.nuke_outer_whitespace) {
-    parts.push(">");
-  }
-
-  if (value.nuke_inner_whitespace) {
-    parts.push("<");
-  }
-
-  if (value.self_closing) {
-    parts.push("/");
-  }
-
-  if (value.value) {
-    const prefix = value.parse ? "= " : ifBreak("", " ");
-
-    return group(
-      concat([
-        group(concat(parts)),
-        indent(concat([softline, prefix, value.value]))
-      ])
-    );
-  }
-
-  // In case none of the other if statements have matched and we're printing a
-  // div, we need to explicitly add it back into the array.
-  if (parts.length === 0 && value.name === "div") {
-    parts.push("%div");
-  }
-
-  return group(concat(parts));
-}
-
-// https://haml.info/docs/yardoc/file.REFERENCE.html#element-name-
-function tag(path, opts, print) {
-  const { children, value } = path.getValue();
-  const header = getHeader(value, opts);
-
-  if (children.length === 0) {
-    return header;
-  }
-
-  return group(
-    concat([
-      header,
-      indent(concat([hardline, join(hardline, path.map(print, "children"))]))
-    ])
-  );
-}
-
-module.exports = tag;

data/src/haml/parser.js

@@ -1,22 +0,0 @@
-const parseSync = require("../parser/parseSync");
-
-const parse = (text, _parsers, opts) => {
-  return parseSync("haml", text, opts);
-};
-
-const pragmaPattern = /^\s*-#\s*@(prettier|format)/;
-const hasPragma = (text) => pragmaPattern.test(text);
-
-// These functions are just placeholders until we can actually perform this
-// properly. The functions are necessary otherwise the format with cursor
-// functions break.
-const locStart = (_node) => 0;
-const locEnd = (_node) => 0;
-
-module.exports = {
-  parse,
-  astFormat: "haml",
-  hasPragma,
-  locStart,
-  locEnd
-};

data/src/haml/printer.js

@@ -1,28 +0,0 @@
-const embed = require("./embed");
-const nodes = {
-  comment: require("./nodes/comment"),
-  doctype: require("./nodes/doctype"),
-  filter: require("./nodes/filter"),
-  haml_comment: require("./nodes/hamlComment"),
-  plain: require("./nodes/plain"),
-  root: require("./nodes/root"),
-  script: require("./nodes/script"),
-  silent_script: require("./nodes/silentScript"),
-  tag: require("./nodes/tag")
-};
-
-const genericPrint = (path, opts, print) => {
-  const { type } = path.getValue();
-
-  /* istanbul ignore next */
-  if (!(type in nodes)) {
-    throw new Error(`Unsupported node encountered: ${type}`);
-  }
-
-  return nodes[type](path, opts, print);
-};
-
-module.exports = {
-  embed,
-  print: genericPrint
-};

data/src/parser/getLang.js

@@ -1,32 +0,0 @@
-// In order to properly parse ruby code, we need to tell the ruby process to
-// parse using UTF-8. Unfortunately, the way that you accomplish this looks
-// differently depending on your platform.
-/* istanbul ignore next */
-function getLang() {
-  const { env, platform } = process;
-  const envValue = env.LC_ALL || env.LC_CTYPE || env.LANG;
-
-  // If an env var is set for the locale that already includes UTF-8 in the
-  // name, then assume we can go with that.
-  if (envValue && envValue.includes("UTF-8")) {
-    return envValue;
-  }
-
-  // Otherwise, we're going to guess which encoding to use based on the system.
-  // This is probably not the best approach in the world, as you could be on
-  // linux and not have C.UTF-8, but in that case you're probably passing an env
-  // var for it. This object below represents all of the possible values of
-  // process.platform per:
-  // https://nodejs.org/api/process.html#process_process_platform
-  return {
-    aix: "C.UTF-8",
-    darwin: "en_US.UTF-8",
-    freebsd: "C.UTF-8",
-    linux: "C.UTF-8",
-    openbsd: "C.UTF-8",
-    sunos: "C.UTF-8",
-    win32: ".UTF-8"
-  }[platform];
-}
-
-module.exports = getLang;

data/src/parser/getNetcat.js

@@ -1,57 +0,0 @@
-const { spawnSync } = require("child_process");
-const os = require("os");
-
-// Checks to see if an executable is available.
-function hasCommand(name) {
-  let result;
-
-  if (os.type() === "Windows_NT") {
-    result = spawnSync("where", [name]);
-  } else {
-    result = spawnSync("command", ["-v", name]);
-  }
-
-  return result.status === 0;
-}
-
-// Finds an netcat-like adapter to use for sending data to a socket. We order
-// these by likelihood of being found so we can avoid some shell-outs.
-function getCommandAndArgs() {
-  if (hasCommand("nc")) {
-    return ["nc", ["-U"]];
-  }
-
-  if (hasCommand("telnet")) {
-    return ["telnet", ["-u"]];
-  }
-
-  if (hasCommand("ncat")) {
-    return ["ncat", ["-U"]];
-  }
-
-  if (hasCommand("socat")) {
-    return ["socat", ["-"]];
-  }
-
-  return ["node", [require.resolve("./netcat.js")]];
-}
-
-let command;
-let args;
-
-function getNetcat(opts) {
-  if (!command) {
-    if (opts.rubyNetcatCommand) {
-      const splits = opts.rubyNetcatCommand.split(" ");
-
-      command = splits[0];
-      args = splits.slice(1);
-    } else {
-      [command, args] = getCommandAndArgs();
-    }
-  }
-
-  return { command, args };
-}
-
-module.exports = getNetcat;

data/src/parser/parseSync.js

@@ -1,43 +0,0 @@
-const requestParse = require("./requestParse");
-
-// Formats and sends a request to the parser server. We use netcat (or something
-// like it) here since Prettier requires the results of `parse` to be
-// synchronous and Node.js does not offer a mechanism for synchronous socket
-// requests.
-function parseSync(parser, source, opts) {
-  const { stdout, stderr, status } = requestParse(parser, source, opts);
-
-  // We need special handling in case the user's version of nc doesn't support
-  // using unix sockets.
-  if (stderr.includes("invalid option -- U")) {
-    throw new Error(`
-      @prettier/plugin-ruby uses netcat to communicate over unix sockets between
-      the node.js process running prettier and an underlying Ruby process used
-      for parsing. Unfortunately the version of netcat that you have installed
-      (GNU netcat) does not support unix sockets. To solve this either uninstall
-      GNU netcat and use a different implementation, or change the value of the
-      rubyNetcatCommand option in your prettier configuration.
-    `);
-  }
-
-  // If we didn't receive anything over stdout or we have a bad exit status,
-  // then throw whatever we can.
-  if (stdout.length === 0 || (status !== null && status !== 0)) {
-    throw new Error(stderr || "An unknown error occurred");
-  }
-
-  const parsed = JSON.parse(stdout);
-
-  if (parsed.error) {
-    const error = new Error(parsed.error);
-    if (parsed.loc) {
-      error.loc = parsed.loc;
-    }
-
-    throw error;
-  }
-
-  return parsed;
-}
-
-module.exports = parseSync;

data/src/parser/requestParse.js

@@ -1,74 +0,0 @@
-const { spawn, spawnSync, execSync } = require("child_process");
-const path = require("path");
-const { existsSync, mkdtempSync } = require("fs");
-const process = require("process");
-const os = require("os");
-
-const getNetcat = require("./getNetcat");
-const getLang = require("./getLang");
-
-let sockfile = process.env.PRETTIER_RUBY_HOST;
-
-// Spawn the parser.rb subprocess. We do this since booting Ruby is slow, and we
-// can re-use the parser process multiple times since it is statelesss.
-function spawnParseServer() {
-  const server = spawn(
-    "ruby",
-    [path.join(__dirname, "./server.rb"), sockfile],
-    {
-      env: Object.assign({}, process.env, { LANG: getLang() }),
-      detached: true,
-      stdio: "inherit"
-    }
-  );
-
-  process.on("exit", () => {
-    try {
-      process.kill(-server.pid);
-    } catch (e) {
-      // ignore
-    }
-  });
-
-  server.unref();
-  const now = new Date();
-
-  // Wait for server to go live.
-  while (!existsSync(sockfile) && new Date() - now < 3000) {
-    execSync("sleep 0.1");
-  }
-}
-
-// Ensures that a parser server is currently running by checking against the
-// sockfile variable. If it is not, create a temporary directory to house the
-// sockfile and spawn the ruby process.
-function ensureParseServer() {
-  if (sockfile) {
-    return;
-  }
-
-  const tmpDir = mkdtempSync(path.join(os.tmpdir(), "prettier-ruby"));
-  sockfile = path.join(tmpDir, `${process.pid}.sock`);
-
-  spawnParseServer();
-}
-
-// Sends a request to the parse server to parse the given content.
-function requestParse(parser, source, opts) {
-  ensureParseServer();
-
-  const { command, args } = getNetcat(opts);
-  const { stdout, stderr, status } = spawnSync(command, args.concat(sockfile), {
-    input: `${parser}|${source}`,
-    maxBuffer: 15 * 1024 * 1024
-  });
-
-  return {
-    command,
-    stdout: stdout.toString(),
-    stderr: stderr.toString(),
-    status
-  };
-}
-
-module.exports = requestParse;

data/src/parser/server.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/setup' if ENV['PLUGIN_RUBY_CI']
-require 'socket'
-require 'json'
-
-require_relative '../ruby/parser'
-require_relative '../rbs/parser'
-require_relative '../haml/parser'
-
-# Set the program name so that it's easy to find if we need it
-$PROGRAM_NAME = 'prettier-ruby-parser'
-
-# Make sure we trap these signals to be sure we get the quit command coming from
-# the parent node process
-quit = false
-trap(:QUIT) { quit = true } if RUBY_PLATFORM != 'java'
-trap(:INT) { quit = true }
-trap(:TERM) { quit = true }
-
-sockfile = ARGV.first || "/tmp/#{$PROGRAM_NAME}.sock"
-server = UNIXServer.new(sockfile)
-
-at_exit do
-  server.close
-  File.unlink(sockfile)
-end
-
-loop do
-  break if quit
-
-  # Start up a new thread that will handle each successive connection.
-  Thread.new(server.accept_nonblock) do |socket|
-    parser, source = socket.read.force_encoding('UTF-8').split('|', 2)
-
-    response =
-      case parser
-      when 'ruby'
-        Prettier::Parser.parse(source)
-      when 'rbs'
-        Prettier::RBSParser.parse(source)
-      when 'haml'
-        Prettier::HAMLParser.parse(source)
-      end
-
-    if response
-      socket.write(JSON.fast_generate(response))
-    else
-      socket.write('{ "error": true }')
-    end
-  rescue Prettier::Parser::ParserError => error
-    loc = { start: { line: error.lineno, column: error.column } }
-    socket.write(JSON.fast_generate(error: error.message, loc: loc))
-  rescue StandardError => error
-    socket.write(JSON.fast_generate(error: error.message))
-  ensure
-    socket.close
-  end
-rescue IO::WaitReadable, Errno::EINTR
-  # Wait for select(2) to give us a connection that has content for 1 second.
-  # Otherwise timeout and continue on (so that we hit our "break if quit"
-  # pretty often).
-  IO.select([server], nil, nil, 1)
-
-  retry unless quit
-end

data/src/plugin.js

@@ -1,148 +0,0 @@
-const rubyPrinter = require("./ruby/printer");
-const rubyParser = require("./ruby/parser");
-
-const rbsPrinter = require("./rbs/printer");
-const rbsParser = require("./rbs/parser");
-
-const hamlPrinter = require("./haml/printer");
-const hamlParser = require("./haml/parser");
-
-/*
- * metadata mostly pulled from linguist and rubocop:
- * https://github.com/github/linguist/blob/master/lib/linguist/languages.yml
- * https://github.com/rubocop-hq/rubocop/blob/master/spec/rubocop/target_finder_spec.rb
- */
-
-module.exports = {
-  languages: [
-    {
-      name: "Ruby",
-      parsers: ["ruby"],
-      extensions: [
-        ".arb",
-        ".axlsx",
-        ".builder",
-        ".eye",
-        ".fcgi",
-        ".gemfile",
-        ".gemspec",
-        ".god",
-        ".jb",
-        ".jbuilder",
-        ".mspec",
-        ".opal",
-        ".pluginspec",
-        ".podspec",
-        ".rabl",
-        ".rake",
-        ".rb",
-        ".rbi",
-        ".rbuild",
-        ".rbw",
-        ".rbx",
-        ".ru",
-        ".ruby",
-        ".thor",
-        ".watchr"
-      ],
-      filenames: [
-        ".irbrc",
-        ".pryrc",
-        ".simplecov",
-        "Appraisals",
-        "Berksfile",
-        "Brewfile",
-        "Buildfile",
-        "Capfile",
-        "Cheffile",
-        "Dangerfile",
-        "Deliverfile",
-        "Fastfile",
-        "Gemfile",
-        "Guardfile",
-        "Jarfile",
-        "Mavenfile",
-        "Podfile",
-        "Puppetfile",
-        "Rakefile",
-        "Snapfile",
-        "Thorfile",
-        "Vagabondfile",
-        "Vagrantfile",
-        "buildfile"
-      ],
-      interpreters: ["jruby", "macruby", "rake", "rbx", "ruby"],
-      linguistLanguageId: 326,
-      vscodeLanguageIds: ["ruby"]
-    },
-    {
-      name: "RBS",
-      parsers: ["rbs"],
-      extensions: [".rbs"]
-    },
-    {
-      name: "HAML",
-      parsers: ["haml"],
-      extensions: [".haml"],
-      vscodeLanguageIds: ["haml"]
-    }
-  ],
-  parsers: {
-    ruby: rubyParser,
-    rbs: rbsParser,
-    haml: hamlParser
-  },
-  printers: {
-    ruby: rubyPrinter,
-    rbs: rbsPrinter,
-    haml: hamlPrinter
-  },
-  options: {
-    rubyArrayLiteral: {
-      type: "boolean",
-      category: "Ruby",
-      default: true,
-      description:
-        "When possible, favor the use of string and symbol array literals."
-    },
-    rubyHashLabel: {
-      type: "boolean",
-      category: "Ruby",
-      default: true,
-      description:
-        "When possible, uses the shortened hash key syntax, as opposed to hash rockets."
-    },
-    rubyModifier: {
-      type: "boolean",
-      category: "Ruby",
-      default: true,
-      description:
-        "When it fits on one line, allows if, unless, while, and until statements to use the modifier form."
-    },
-    rubyNetcatCommand: {
-      type: "string",
-      category: "Ruby",
-      description:
-        'The prefix of the command to execute to communicate between the node.js process and the Ruby process. (For example, "nc -U" or "telnet -u") Normally you should not set this option.'
-    },
-    rubySingleQuote: {
-      type: "boolean",
-      category: "Ruby",
-      default: true,
-      description:
-        "When double quotes are not necessary for interpolation, prefers the use of single quotes for string literals."
-    },
-    rubyToProc: {
-      type: "boolean",
-      category: "Ruby",
-      default: false,
-      description:
-        "When possible, convert blocks to the more concise Symbol#to_proc syntax."
-    }
-  },
-  defaultOptions: {
-    printWidth: 80,
-    tabWidth: 2,
-    trailingComma: "none"
-  }
-};

data/src/prettier.js

@@ -1,16 +0,0 @@
-// If `RBPRETTIER` is set, then this is being run from the `Prettier::run` ruby
-// method. In that case, we need to pull `prettier` from the node_modules
-// directly, as it's been shipped with the gem.
-/* istanbul ignore next */
-const source = process.env.RBPRETTIER ? "../node_modules/prettier" : "prettier";
-
-const prettier = require(source);
-
-// Just combine all the things into one big object so that we can import
-// whatever we need from prettier without having to dive too deeply.
-module.exports = Object.assign(
-  {},
-  prettier.doc.builders,
-  prettier.doc.utils,
-  prettier.util
-);