Merge pull request #464 from peterramsing/what-if-i-typescript

Migrate core to TypeScript

.eslintignore

@@ -1,7 +1,7 @@
 docs/*
+dist/*
+test/*
 .nyc_output
 coverage
 
-// FIXME: kill these
-test/check.js
-test/lost-nesting.js
+//FIXME: fix tests

.eslintrc.js

@@ -3,11 +3,14 @@ module.exports = {
  node: true,
  },
  plugins: ['prettier'],
- extends: 'eslint:recommended',
+ extends: 'plugin:@typescript-eslint/recommended',
+ parser: '@typescript-eslint/parser',
  parserOptions: {
  ecmaVersion: 2022,
+ sourceType: 'module',
  },
  rules: {
+ '@typescript-eslint/no-explicit-any': 'off', //FIXME: remove this
  'eol-last': 2,
  'no-multiple-empty-lines': [2, { max: 2, maxEOF: 1 }],
  'linebreak-style': ['error', 'unix'],

.github/workflows/node.js.yml

@@ -30,6 +30,7 @@ jobs:
  node-version: ${{ matrix.node-version }}
  cache: 'npm'
  - run: npm ci
+ - run: npm run build
  - run: npm test
  - run: npm run lint
  - run: npm run report-coverage

.gitignore

@@ -1,5 +1,7 @@
 # Created by https://www.gitignore.io
 
+dist
+
 ### Node ###
 # Logs
 logs

.vscode/settings.json

@@ -1,3 +1,6 @@
 {
- "cSpell.words": ["codecov", "flexbox", "lcov", "linebreak"]
+ "cSpell.words": ["codecov", "flexbox", "lcov", "linebreak"],
+ "editor.codeActionsOnSave": {
+ "source.fixAll.eslint": true
+ }
 }

CONTRIBUTING.md

@@ -22,42 +22,4 @@ Thanks, and don't hesitate to reach out if you have any questions!
 
 ## Git Hooks for LostGrid
 
-LostGrid requires linting in order for PR's to be accepted.
-
-Having a pre-commit hook is a great way to enforce this before CI catches it.
-
-This was taken from Angular's Material project nearly wholesale. Thanks to them for the great docs!
-Read how: [Material2's Wiki](https://github.com/angular/material2/wiki/Pre-commit-hook-for-linters)
-
-`pre-commit` code for LostGrid's linter
-
-```bash
-#!/bin/sh
-
-pass=true
-RED='\033[1;31m'
-GREEN='\033[0;32m'
-NC='\033[0m'
-
-echo "Running Linter:"
-
-# Run elsint and get the output and return code
-eslint=$(npm run lint)
-ret_code=$?
-
-# If it didn't pass, announce it failed and print the output
-if [ $ret_code != 0 ]; then
- printf "\n${RED}eslint failed:${NC}"
- echo "$eslint\n"
- pass=false
-else
- printf "${GREEN}eslint passed.${NC}\n"
-fi
-
-# If there were no failures, it is good to commit
-if $pass; then
- exit 0
-fi
-
-exit 1
-```
+Husky should take care of this for you now

README.md

@@ -25,6 +25,13 @@ LostGrid makes use of [`calc()`](https://developer.mozilla.org/en-US/docs/Web/CS
 
 Read the docs on [LostGrid.org](http://lostgrid.org/docs.html)!
 
+## Roadmap
+
+- [ ] Migrate the core of the code to TypeScript
+- [ ] Remove a lot of the complexity, focusing on moving complexity to CSS Grid
+- [ ] Optimize LostGrid to support CSS Grid, getting out of the way while helping enabled developers to use CSS Grid
+- [ ] Maintain backwards compatibility with older browsers for those who need it
+
 ## Browser Support
 
 - LostGrid relies on [`calc()`](https://developer.mozilla.org/en-US/docs/Web/CSS/calc) to create the grid. Thus, LostGrid is limited to browsers that support `calc()`. The great thing is that `calc()` is widely supported in all current browsers and the LostGrid usage of `calc()` is supported as far back as IE9+.