Skip to content

[WIP] Emitting value and type information for IDE/IDE-like consumers #4284

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
purefunctor wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

[WIP] Emitting value and type information for IDE/IDE-like consumers #4284

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4f92adf
Start work on PureScript IDE Information
purefunctor Apr 9, 2022
a3700f5
Minimal working example of collecting information
purefunctor Apr 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Start work on PureScript IDE Information
  • Loading branch information
@purefunctor
purefunctor committed Apr 9, 2022
commit 4f92adfa20b56e25a9703c3741f25f53122e129e
1 change: 1 addition & 0 deletions purescript.cabal
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,7 @@ library
Language.PureScript.Ide.Types
Language.PureScript.Ide.Usage
Language.PureScript.Ide.Util
Language.PureScript.Ide.Psii
Language.PureScript.Interactive
Language.PureScript.Interactive.Completion
Language.PureScript.Interactive.Directive
Expand Down
28 changes: 28 additions & 0 deletions src/Language/PureScript/Ide/Psii.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
-- |
-- `psii` stands for `PureScript IDE Information`.
--
-- Q: How to read `psii`?
-- A: As in "psy" or "sai".
module Language.PureScript.Ide.Psii where

import Protolude

-- |
-- The verbosity of IDE information.
data PsiiVerbosity
-- | Include no information at all.
= PsiiNoInformation
-- | Include top-level information.
| PsiiOnlyTopLevel
-- | Include local information.
| PsiiWithLocal
deriving (Show, Eq, Ord)

-- |
-- The information entry to be emitted.
data PsiiInformation
-- | A declaration in a source file.
= PsiiDeclaration
-- | A reference to a declaration.
| PsiiReference
deriving (Show, Eq, Ord)
7 changes: 6 additions & 1 deletion src/Language/PureScript/TypeChecker/Monad.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import qualified Data.List.NonEmpty as NEL
import Language.PureScript.Crash (internalError)
import Language.PureScript.Environment
import Language.PureScript.Errors
import Language.PureScript.Ide.Psii
import Language.PureScript.Names
import Language.PureScript.Pretty.Types
import Language.PureScript.Pretty.Values
Expand Down Expand Up @@ -104,11 +105,15 @@ data CheckState = CheckState
, checkConstructorImportsForCoercible :: S.Set (ModuleName, Qualified (ProperName 'ConstructorName))
-- ^ Newtype constructors imports required to solve Coercible constraints.
-- We have to keep track of them so that we don't emit unused import warnings.
, checkPsiiVerbosity :: PsiiVerbosity
-- ^ The verbosity of IDE information to be collected.
, checkPsiiInformation :: S.Set (PsiiInformation)
-- ^ The IDE information collected through type-checking.
}

-- | Create an empty @CheckState@
emptyCheckState :: Environment -> CheckState
emptyCheckState env = CheckState env 0 0 0 Nothing [] emptySubstitution [] mempty
emptyCheckState env = CheckState env 0 0 0 Nothing [] emptySubstitution [] mempty PsiiNoInformation mempty

-- | Unification variables
type Unknown = Int
Expand Down