Add rule to check for types property in package.json - fixes #11

Author: SamVerschueren

source/lib/rules/index.ts

@@ -1,11 +1,13 @@
 import filesProperty from './files-property';
+import typesProperty from './types-property';
 import {Diagnostic, Context} from '../interfaces';
 
 type RuleFunction = (context: Context) => Diagnostic[];
 
 // List of custom rules
 const rules = new Set<RuleFunction>([
-	filesProperty
+	filesProperty,
+	typesProperty
 ]);
 
 /**

source/lib/rules/types-property.ts

@@ -0,0 +1,39 @@
+import * as path from 'path';
+import * as fs from 'fs';
+import {Context, Diagnostic} from '../interfaces';
+import {getJSONPropertyPosition} from '../utils';
+
+/**
+ * Rule which enforces the use of a `types` property over a `typings` property.
+ *
+ * @param context - The context object.
+ * @returns A list of custom diagnostics.
+ */
+export default (context: Context): Diagnostic[] => {
+	const {pkg} = context;
+
+	if (!pkg.types && !pkg.typings) {
+		return [
+			{
+				fileName: 'package.json',
+				message: 'Can\'t find `types` property.',
+				severity: 'error'
+			}
+		];
+	}
+
+	if (!pkg.types && pkg.typings) {
+		const content = fs.readFileSync(path.join(context.cwd, 'package.json'), 'utf8');
+
+		return [
+			{
+				fileName: 'package.json',
+				message: 'Use property `types` instead of `typings`.',
+				severity: 'error',
+				...getJSONPropertyPosition(content, 'typings')
+			}
+		];
+	}
+
+	return [];
+};

source/test/fixtures/expect-error/functions/package.json

@@ -1,3 +1,4 @@
 {
-	"name": "foo"
+	"name": "foo",
+	"types": "index.d.ts"
 }

source/test/fixtures/expect-error/syntax/package.json

@@ -1,3 +1,4 @@
 {
-	"name": "foo"
+	"name": "foo",
+	"types": "index.d.ts"
 }

source/test/fixtures/expect-error/values/package.json

@@ -1,3 +1,4 @@
 {
-	"name": "foo"
+	"name": "foo",
+	"types": "index.d.ts"
 }

source/test/fixtures/failure-nested/package.json

@@ -1,3 +1,4 @@
 {
-	"name": "foo"
+	"name": "foo",
+	"types": "index.d.ts"
 }

source/test/fixtures/failure-strict-null-checks/package.json

@@ -1,3 +1,4 @@
 {
-	"name": "foo"
+	"name": "foo",
+	"types": "index.d.ts"
 }

source/test/fixtures/failure/package.json

@@ -1,3 +1,4 @@
 {
-	"name": "foo"
+	"name": "foo",
+	"types": "index.d.ts"
 }

source/test/fixtures/no-files/package.json

@@ -1,5 +1,6 @@
 {
 	"name": "foo",
+	"types": "index.d.ts",
 	"files": [
 		"index.js"
 	]

source/test/fixtures/no-test/package.json

@@ -1,3 +1,4 @@
 {
-	"name": "foo"
+	"name": "foo",
+	"types": "index.d.ts"
 }

source/test/fixtures/non-strict-check-with-config/package.json

@@ -1,5 +1,6 @@
 {
 	"name": "foo",
+	"types": "index.d.ts",
 	"tsd-check": {
 		"compilerOptions": {
 			"strict": false

source/test/fixtures/success/package.json

@@ -1,5 +1,6 @@
 {
 	"name": "foo",
+	"types": "index.d.ts",
 	"files": [
 		"index.js",
 		"index.d.ts"

source/test/fixtures/test-in-subdir/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "foo",
 	"main": "src/index.js",
-	"typings": "src/index.d.ts",
+	"types": "src/index.d.ts",
 	"files": [
 		"src/index.js",
 		"src/index.d.ts"

source/test/fixtures/test-non-barrel-main/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "foo",
 	"main": "foo.js",
-	"typings": "foo.d.ts",
+	"types": "foo.d.ts",
 	"files": [
 		"foo.js",
 		"foo.d.ts"

source/test/fixtures/top-level-await/package.json

@@ -1,5 +1,6 @@
 {
 	"name": "foo",
+	"types": "index.d.ts",
 	"files": [
 		"index.js",
 		"index.d.ts"

source/test/fixtures/types-property/no-property/index.d.ts

@@ -0,0 +1,3 @@
+{
+	"name": "foo"
+}

source/test/fixtures/types-property/no-property/index.test-d.ts

@@ -0,0 +1,4 @@
+{
+	"name": "foo",
+	"typings": "index.d.ts"
+}

source/test/fixtures/types-property/no-property/package.json

@@ -37,12 +37,38 @@ test('fail if typings file is not part of `files` list', async t => {
 			fileName: 'package.json',
 			message: 'TypeScript type definition `index.d.ts` is not part of the `files` list.',
 			severity: 'error',
-			line: 3,
+			line: 4,
 			column: 1
 		}
 	]);
 });
 
+test('fail if `types` property is not set', async t => {
+	const diagnostics = await m({cwd: path.join(__dirname, 'fixtures/types-property/no-property')});
+
+	t.deepEqual(diagnostics, [
+		{
+			fileName: 'package.json',
+			message: 'Can\'t find `types` property.',
+			severity: 'error'
+		}
+	]);
+});
+
+test('fail if `typings` property is is used instead of `types`', async t => {
+	const diagnostics = await m({cwd: path.join(__dirname, 'fixtures/types-property/typings')});
+
+	t.deepEqual(diagnostics, [
+		{
+			fileName: 'package.json',
+			message: 'Use property `types` instead of `typings`.',
+			severity: 'error',
+			column: 1,
+			line: 3
+		}
+	]);
+});
+
 test('fail if tests don\'t pass in strict mode', async t => {
 	const diagnostics = await m({
 		cwd: path.join(__dirname, 'fixtures/failure-strict-null-checks')