feat(prettier): use Prettier to determine whether a file is formattable

Instead of relying on the user to supply prettier-atom with a whole list of Atom scopes for each Prettier parser type, we instead rely on the new getFileInfo method from Prettier and let Prettier tell us whether or not a file is parseable. This will make future parser support automatic as well as allow Prettier plugins to work. Unfortunately, because we rely on this new feature from Prettier, it will mean that users will be forced to upgrade their local Prettier versions to be compatible. BREAKING CHANGE: Because prettier-atom now relies on the new `getFileInfo` method recently added to Prettier, if you are having prettier-atom use a local version of Prettier instead of the version that is packaged with the plugin, you will need to manually update your project's local Prettier version.
prettier · Apr 30, 2018 · ad88808 · ad88808
1 parent 1857831
commit ad88808
Show file tree

Hide file tree

Showing 24 changed files with 153 additions and 242 deletions.
diff --git a/dist/atomInterface/index.js b/dist/atomInterface/index.js
@@ -39,8 +39,6 @@ const getAtomVersion = () => atom.getVersion();
 
 const getPrettierAtomConfig = () => atom.config.get('prettier-atom');
 
-const getScopes = () => getConfigOption('scopes');
-
 const getWhitelistedGlobs = () => getConfigOption('formatOnSaveOptions.whitelistedGlobs');
 
 const getExcludedGlobs = () => getConfigOption('formatOnSaveOptions.excludedGlobs');
@@ -78,7 +76,6 @@ module.exports = {
   getAtomVersion,
   getPrettierAtomConfig,
   getPrettierEslintOptions,
-  getScopes,
   getWhitelistedGlobs,
   getExcludedGlobs,
   isDisabledIfNotInPackageJson,

diff --git a/dist/config-schema.json b/dist/config-schema.json
diff --git a/dist/editorInterface/index.js b/dist/editorInterface/index.js
@@ -2,8 +2,6 @@
 
 const path = require('path');
 
-const { getScopes } = require('../atomInterface');
-
 let flow;
 const lazyFlow = () => {
   if (!flow) {
@@ -23,8 +21,6 @@ const isCurrentScopeEmbeddedScope = editor => EMBEDDED_SCOPES.includes(getCurren
 
 const isCurrentScopeStyleLintScope = editor => STYLELINT_SCOPES.includes(getCurrentScope(editor));
 
-const isInScope = editor => getScopes().includes(getCurrentScope(editor));
-
 const getCurrentFilePath = editor => editor.buffer.file ? editor.buffer.file.getPath() : undefined;
 
 const getCurrentDir = editor => lazyFlow()(getCurrentFilePath, maybeFilePath => typeof maybeFilePath === 'string' ? path.dirname(maybeFilePath) : undefined)(editor);
@@ -33,7 +29,6 @@ module.exports = {
   getBufferRange,
   isCurrentScopeEmbeddedScope,
   isCurrentScopeStyleLintScope,
-  isInScope,
   getCurrentScope,
   getCurrentFilePath,
   getCurrentDir

diff --git a/dist/formatOnSave/isFilePathPrettierIgnored.js b/dist/formatOnSave/isFilePathPrettierIgnored.js
diff --git a/dist/formatOnSave/shouldFormatOnSave.js b/dist/formatOnSave/shouldFormatOnSave.js
@@ -1,8 +1,8 @@
 'use strict';
 
 const _ = require('lodash/fp');
-const { getPrettierInstance, someGlobsMatchFilePath } = require('../helpers');
-const { getCurrentFilePath, isInScope } = require('../editorInterface');
+const { getPrettierInstance, someGlobsMatchFilePath, isFileFormattable } = require('../helpers');
+const { getCurrentFilePath } = require('../editorInterface');
 const {
   getExcludedGlobs,
   getWhitelistedGlobs,
@@ -12,7 +12,6 @@ const {
   shouldRespectEslintignore
 } = require('../atomInterface');
 const isFilePathEslintIgnored = require('./isFilePathEslintIgnored');
-const isFilePathPrettierIgnored = require('./isFilePathPrettierIgnored');
 const isPrettierInPackageJson = require('./isPrettierInPackageJson');
 
 const hasFilePath = editor => !!getCurrentFilePath(editor);
@@ -26,8 +25,6 @@ const isFilePathWhitelisted = _.flow(getCurrentFilePath, filePath => someGlobsMa
 
 const isEslintIgnored = _.flow(getCurrentFilePath, isFilePathEslintIgnored);
 
-const isFilePathNotPrettierIgnored = _.flow(getCurrentFilePath, _.negate(isFilePathPrettierIgnored));
-
 const isResolveConfigDefined = (editor
 // $FlowFixMe
 ) => !!getPrettierInstance(editor).resolveConfig.sync;
@@ -38,6 +35,6 @@ const isResolveConfigSuccessful = (editor
 
 const isPrettierConfigPresent = _.overEvery([isResolveConfigDefined, isResolveConfigSuccessful]);
 
-const shouldFormatOnSave = _.overEvery([isFormatOnSaveEnabled, hasFilePath, isInScope, _.overSome([isFilePathWhitelisted, _.overEvery([noWhitelistGlobsPresent, filePathDoesNotMatchBlacklistGlobs])]), _.overSome([_.negate(shouldRespectEslintignore), _.negate(isEslintIgnored)]), isFilePathNotPrettierIgnored, _.overSome([_.negate(isDisabledIfNotInPackageJson), isPrettierInPackageJson]), _.overSome([_.negate(isDisabledIfNoConfigFile), isPrettierConfigPresent])]);
+const shouldFormatOnSave = _.overEvery([isFormatOnSaveEnabled, hasFilePath, _.overSome([isFilePathWhitelisted, _.overEvery([noWhitelistGlobsPresent, filePathDoesNotMatchBlacklistGlobs])]), _.overSome([_.negate(shouldRespectEslintignore), _.negate(isEslintIgnored)]), _.overSome([_.negate(isDisabledIfNotInPackageJson), isPrettierInPackageJson]), _.overSome([_.negate(isDisabledIfNoConfigFile), isPrettierConfigPresent]), isFileFormattable]);
 
 module.exports = shouldFormatOnSave;
diff --git a/dist/helpers/index.js b/dist/helpers/index.js
@@ -9,7 +9,9 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 const getPrettierInstance = require('./getPrettierInstance');
 const general = require('./general');
 const atomRelated = require('./atomRelated');
+const isFileFormattable = require('./isFileFormattable');
 
 module.exports = (0, _extends3.default)({}, general, atomRelated, {
-  getPrettierInstance
+  getPrettierInstance,
+  isFileFormattable
 });
diff --git a/dist/helpers/isFileFormattable.js b/dist/helpers/isFileFormattable.js
@@ -0,0 +1,11 @@
+'use strict';
+
+const _ = require('lodash/fp');
+const getPrettierInstance = require('./getPrettierInstance');
+const { getCurrentFilePath } = require('../editorInterface');
+
+const isFileFormattable = editor => !!editor && !!getCurrentFilePath(editor) && _.flow(getCurrentFilePath,
+// $FlowFixMe: getFileInfo is not yet added to flow typed
+filePath => getPrettierInstance().getFileInfo(filePath, {}, '.prettierignore'), fileInfo => fileInfo.exists && !fileInfo.ignored && !!fileInfo.inferredParser)(editor);
+
+module.exports = isFileFormattable;
diff --git a/dist/statusTile/updateStatusTileScope.js b/dist/statusTile/updateStatusTileScope.js
@@ -1,12 +1,11 @@
 'use strict';
 
-const { getCurrentScope } = require('../editorInterface');
-const { getScopes } = require('../atomInterface');
+const { isFileFormattable } = require('../helpers');
 
 const updateStatusTileScope = (element, editor) => {
   // The editor can be undefined if there is no active editor (e.g. closed all tabs).
   // eslint-disable-next-line no-param-reassign
-  element.dataset.prettierMatchScope = editor && getScopes().includes(getCurrentScope(editor)) ? 'true' : 'false';
+  element.dataset.prettierCanFormatFile = editor && isFileFormattable(editor) ? 'true' : 'false';
 };
 
 module.exports = updateStatusTileScope;
diff --git a/package.json b/package.json
@@ -27,7 +27,7 @@
     "ignore": "^3.3.7",
     "lodash": "^4.17.5",
     "loophole": "^1.1.0",
-    "prettier": "1.12.1",
+    "prettier": "github:kachkaev/prettier#file-info-dist",
     "prettier-eslint": "^8.8.1",
     "prettier-stylelint": "^0.4.2",
     "read-pkg-up": "^3.0.0",

diff --git a/src/atomInterface/index.js b/src/atomInterface/index.js
@@ -38,8 +38,6 @@ const getAtomVersion = () => atom.getVersion();
 
 const getPrettierAtomConfig = () => atom.config.get('prettier-atom');
 
-const getScopes = () => getConfigOption('scopes');
-
 const getWhitelistedGlobs = () => getConfigOption('formatOnSaveOptions.whitelistedGlobs');
 
 const getExcludedGlobs = () => getConfigOption('formatOnSaveOptions.excludedGlobs');
@@ -77,7 +75,6 @@ module.exports = {
   getAtomVersion,
   getPrettierAtomConfig,
   getPrettierEslintOptions,
-  getScopes,
   getWhitelistedGlobs,
   getExcludedGlobs,
   isDisabledIfNotInPackageJson,

diff --git a/src/config-schema.json b/src/config-schema.json
@@ -15,36 +15,6 @@
     "default": false,
     "order": 2
   },
-  "scopes": {
-    "title": "Only format if a Prettier config is found",
-    "description":
-      "Select which files should be formatted.<br>Use the command `Editor: Log Cursor Scope` to determine the scopes for a file.",
-    "type": "array",
-    "default": [
-      "source.js",
-      "source.jsx",
-      "source.js.jsx",
-      "source.babel",
-      "source.js-semantic",
-      "text.html.basic",
-      "text.html.vue",
-      "source.css",
-      "source.less",
-      "source.css.less",
-      "source.scss",
-      "source.css.scss",
-      "source.css.postcss",
-      "source.json",
-      "source.graphql",
-      "source.md",
-      "source.gfm",
-      "text.md"
-    ],
-    "items": {
-      "type": "string"
-    },
-    "order": 3
-  },
   "formatOnSaveOptions": {
     "title": "Format on Save",
     "order": 4,

diff --git a/src/editorInterface/index.js b/src/editorInterface/index.js
@@ -1,9 +1,6 @@
 // @flow
-
 const path = require('path');
 
-const { getScopes } = require('../atomInterface');
-
 let flow;
 const lazyFlow = () => {
   if (!flow) {
@@ -31,8 +28,6 @@ const isCurrentScopeEmbeddedScope = (editor: TextEditor) => EMBEDDED_SCOPES.incl
 const isCurrentScopeStyleLintScope = (editor: TextEditor) =>
   STYLELINT_SCOPES.includes(getCurrentScope(editor));
 
-const isInScope = (editor: TextEditor) => getScopes().includes(getCurrentScope(editor));
-
 const getCurrentFilePath: (editor: TextEditor) => ?FilePath = editor =>
   editor.buffer.file ? editor.buffer.file.getPath() : undefined;
 
@@ -46,7 +41,6 @@ module.exports = {
   getBufferRange,
   isCurrentScopeEmbeddedScope,
   isCurrentScopeStyleLintScope,
-  isInScope,
   getCurrentScope,
   getCurrentFilePath,
   getCurrentDir,

diff --git a/src/formatOnSave/isFilePathPrettierIgnored.js b/src/formatOnSave/isFilePathPrettierIgnored.js
diff --git a/src/formatOnSave/isFilePathPrettierIgnored.test.js b/src/formatOnSave/isFilePathPrettierIgnored.test.js
diff --git a/src/formatOnSave/shouldFormatOnSave.js b/src/formatOnSave/shouldFormatOnSave.js
@@ -1,7 +1,7 @@
 // @flow
 const _ = require('lodash/fp');
-const { getPrettierInstance, someGlobsMatchFilePath } = require('../helpers');
-const { getCurrentFilePath, isInScope } = require('../editorInterface');
+const { getPrettierInstance, someGlobsMatchFilePath, isFileFormattable } = require('../helpers');
+const { getCurrentFilePath } = require('../editorInterface');
 const {
   getExcludedGlobs,
   getWhitelistedGlobs,
@@ -11,7 +11,6 @@ const {
   shouldRespectEslintignore,
 } = require('../atomInterface');
 const isFilePathEslintIgnored = require('./isFilePathEslintIgnored');
-const isFilePathPrettierIgnored = require('./isFilePathPrettierIgnored');
 const isPrettierInPackageJson = require('./isPrettierInPackageJson');
 
 const hasFilePath = (editor: TextEditor) => !!getCurrentFilePath(editor);
@@ -31,11 +30,6 @@ const isFilePathWhitelisted: (editor: TextEditor) => boolean = _.flow(
 
 const isEslintIgnored: (editor: TextEditor) => boolean = _.flow(getCurrentFilePath, isFilePathEslintIgnored);
 
-const isFilePathNotPrettierIgnored: (editor: TextEditor) => boolean = _.flow(
-  getCurrentFilePath,
-  _.negate(isFilePathPrettierIgnored),
-);
-
 const isResolveConfigDefined = (editor: TextEditor): boolean =>
   // $FlowFixMe
   !!getPrettierInstance(editor).resolveConfig.sync;
@@ -52,15 +46,14 @@ const isPrettierConfigPresent: TextEditor => boolean = _.overEvery([
 const shouldFormatOnSave: (editor: TextEditor) => boolean = _.overEvery([
   isFormatOnSaveEnabled,
   hasFilePath,
-  isInScope,
   _.overSome([
     isFilePathWhitelisted,
     _.overEvery([noWhitelistGlobsPresent, filePathDoesNotMatchBlacklistGlobs]),
   ]),
   _.overSome([_.negate(shouldRespectEslintignore), _.negate(isEslintIgnored)]),
-  isFilePathNotPrettierIgnored,
   _.overSome([_.negate(isDisabledIfNotInPackageJson), isPrettierInPackageJson]),
   _.overSome([_.negate(isDisabledIfNoConfigFile), isPrettierConfigPresent]),
+  isFileFormattable,
 ]);
 
 module.exports = shouldFormatOnSave;