Prepare example and scaffolding (#5)

* Flesh out example library * More package prep
spautz · Apr 3, 2021 · 9a4296f · 9a4296f
1 parent 9f82380
commit 9a4296f
Show file tree

Hide file tree

Showing 24 changed files with 89 additions and 119 deletions.
diff --git a/examples/demo-library/.prettierignore b/examples/demo-library/.prettierignore
diff --git a/examples/demo-library/LICENSE b/examples/demo-library/LICENSE
diff --git a/examples/demo-library/jest.config.js b/examples/demo-library/jest.config.js
diff --git a/examples/demo-library/package.json b/examples/demo-library/package.json
diff --git a/examples/demo-library/prettier.config.js b/examples/demo-library/prettier.config.js
diff --git a/examples/demo-library/src/index.ts b/examples/demo-library/src/index.ts
diff --git a/examples/example-library/.gitattributes b/examples/example-library/.gitattributes
@@ -0,0 +1 @@
+* text=auto
diff --git a/examples/example-library/.gitignore b/examples/example-library/.gitignore
@@ -0,0 +1,7 @@
+*.log*
+.DS_Store
+
+.idea/
+coverage/
+dist/
+node_modules/
diff --git a/examples/example-library/.npmrc b/examples/example-library/.npmrc
@@ -0,0 +1 @@
+save-exact=true
diff --git a/examples/example-library/.nvmrc b/examples/example-library/.nvmrc
@@ -0,0 +1 @@
+14.16.0
diff --git a/examples/example-library/.packagelint.js b/examples/example-library/.packagelint.js
@@ -0,0 +1,30 @@
+modult.exports = {
+  defaultErrorLevel: 'error',
+  failOnErrorLevel: 'error',
+  rules: [
+    // `@packagelint/core` defines the rules, but rules are disabled by default:
+    // each `@packagelint/recommended-...` ruleset enables a default set of core rules.
+    '@packagelint/recommended-library-rules',
+
+    // Update the `nvmrc` rule to require at least Node 14, instead of the default.
+    // This could also be written like this, if you prefer shorthand:
+    //  ['@packagelint/core/nvmrc', { minVersion: '14' }],
+    {
+      name: '@packagelint/core/nvmrc',
+      options: {
+        minVersion: '14',
+      },
+    },
+
+    // Update the `npmrc` rule to require `save-exact=true`.
+    // You would use a similar approach if your organization requires a specific `registry` to be set in .npmrc
+    {
+      name: '@packagelint/core/npmrc',
+      options: {
+        requireValues: {
+          'save-exact': 'true',
+        },
+      },
+    },
+  ],
+};
diff --git a/examples/demo-library/README.md → examples/example-library/README.md b/examples/demo-library/README.md → examples/example-library/README.md
diff --git a/examples/example-library/package.json b/examples/example-library/package.json
@@ -0,0 +1,28 @@
+{
+  "name": "@packagelint/example-library",
+  "private": true,
+  "version": "0.0.1",
+  "description": "A demo configuration of packagelint for a library",
+  "license": "MIT",
+  "homepage": "https://github.com/spautz/packagelint/tree/main/examples/demo-library#readme",
+  "bugs": "https://github.com/spautz/packagelint/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/spautz/packagelint.git",
+    "directory": "examples/demo-library"
+  },
+  "author": {
+    "name": "Steven Pautz",
+    "url": "http://stevenpautz.com/"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "packagelint": "packagelint"
+  },
+  "devDependencies": {
+    "@packagelint/core": "^0.0.1",
+    "@packagelint/recommended-library-rules": "^0.0.1"
+  }
+}
diff --git a/examples/example-library/src/index.ts b/examples/example-library/src/index.ts
@@ -0,0 +1,5 @@
+const exampleLibraryFn = () => {
+  console.log('exampleLibraryFn!');
+};
+
+export { exampleLibraryFn };
diff --git a/examples/demo-library/tsconfig.json → examples/example-library/tsconfig.json b/examples/demo-library/tsconfig.json → examples/example-library/tsconfig.json
diff --git a/jest-packages.config.js b/jest-packages.config.js
@@ -2,6 +2,6 @@
 
 module.exports = {
   coverageDirectory: 'coverage-local',
-  collectCoverageFrom: ['src/**/*.{js,jsx,ts,tsx}'],
+  collectCoverageFrom: ['{src,lib,lib-src}/**/*.{js,jsx,ts,tsx}'],
   coveragePathIgnorePatterns: ['.*\\.(ignored|stories|test)\\.*', 'node_modules/'],
 };
diff --git a/jest.config.js b/jest.config.js
@@ -2,6 +2,6 @@
 
 module.exports = {
   coverageDirectory: 'coverage',
-  collectCoverageFrom: ['packages/*/src/**/*.{js,jsx,ts,tsx}'],
+  collectCoverageFrom: ['packages/*/{src,lib,lib-src}/**/*.{js,jsx,ts,tsx}'],
   coveragePathIgnorePatterns: ['.*\\.(ignored|stories|test)\\.*', 'node_modules/'],
 };
diff --git a/lerna.json b/lerna.json
@@ -1,6 +1,6 @@
 {
   "lerna": "3.22.1",
-  "packages": ["examples/*", "packages/*"],
+  "packages": ["packages/*"],
   "version": "independent",
   "npmClient": "yarn",
   "useWorkspaces": true,

diff --git a/package.json b/package.json
@@ -87,7 +87,6 @@
     }
   },
   "workspaces": [
-    "examples/*",
     "packages/*"
   ]
 }
diff --git a/packages/core/bin/packagelint.ts b/packages/core/bin/packagelint.ts
@@ -0,0 +1 @@
+console.log('@TODO');
diff --git a/packages/core/src/index.ts → packages/core/lib-src/api.ts b/packages/core/src/index.ts → packages/core/lib-src/api.ts
diff --git a/packages/core/lib-src/cli.ts b/packages/core/lib-src/cli.ts
@@ -0,0 +1 @@
+export {};
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -19,16 +19,18 @@
     "access": "public"
   },
   "files": [
-    "dist/",
-    "src/",
+    "bin/",
+    "lib-dist/",
+    "lib-src/",
     "LICENSE",
     "*.md"
   ],
-  "source": "src/index.ts",
-  "main": "dist/index.js",
-  "module": "dist/packagelint-core.esm.js",
-  "jsnext:main": "dist/packagelint-core.esm.js",
-  "types": "dist/index.d.ts",
+  "bin": {
+    "packagelint": "bin/packagelint.js"
+  },
+  "source": "lib-src/api.ts",
+  "main": "lib-dist/api.js",
+  "types": "lib-dist/types.d.ts",
   "sideEffects": false,
   "scripts": {
     "____ LIFECYCLE HOOKS _______________________________________________": "",

diff --git a/packages/core/tsconfig.json b/packages/core/tsconfig.json
@@ -2,11 +2,11 @@
   "extends": "../../tsconfig",
 
   "compilerOptions": {
-    "rootDir": "./src",
+    "rootDir": "./lib-src",
     "baseUrl": "./"
   },
   // The "include" for packages is specifically for build: the package-level typecheck doesn't check tests/
   // The "include" for the root is for typechecking the entire project (but it doesn't affect the build)
-  "include": ["./src"],
+  "include": ["./lib-src"],
   "exclude": ["node_modules"]
 }